appium_lib_core 4.4.0 → 5.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36bc11abad71f0b61f3902570054786eb70d8d0135584828e84ddfa25dc81b4a
-  data.tar.gz: da818427f4f45e73f2ae90f2dacc2fc35379995dd39786756204f8c0cd5fedad
+  metadata.gz: 7d181fc3278538381590906e61508d9a2200e59f531ba60204e69a5703adc4c7
+  data.tar.gz: a599869012ce5c6644686fe08faa3f56da739aad5f8c9d429495b4791a51c113
 SHA512:
-  metadata.gz: 560ff8bddf417b69da3640a1aa6a4c31e808bce4a7a3bf98f7e27f0095cab87281cc7749390a195af20d1567b09e158a3ccb8621bf7c957d04232223a8437f0d
-  data.tar.gz: e8320e4b60b28b997540f45702864a3637d5be30fdd414f3f19d4400ecc4e71d2169f70cfe5c06d0bf22f9817a5e43853d599522e42a09e9ffb96e9768f53e43
+  metadata.gz: 3cde51ee7eba948cba06c82f6bb3e3d496fb8f7d68c0d9f92c9e76de86909df27bfe1ec312e7ed8e58225fcaa09b46b317977a530d431e24455d5e1cd349646a
+  data.tar.gz: bbd2c4940a57a8e8e601fbe01d13d5d67bb42c5ca7ff36fde5ea94d7099784df4e3afe74a4cdf2400cb0d16d5e37b74971d88054b381498743cd04d6abeb99fe

data/.github/workflows/unittest.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.4, 2.5, 2.6, 2.7, 3.0]
+        ruby: [2.5, 2.6, 2.7, 3.0]
 
     runs-on: ubuntu-latest
 
@@ -38,7 +38,7 @@ jobs:
       fail-fast: false
       matrix:
         # Does not add 2.7 on Windows so far since a command fails only on Windows
-        ruby: [2.4, 2.5, 2.6]
+        ruby: [2.5, 2.6]
 
     runs-on: windows-latest
 

data/CHANGELOG.md

@@ -10,8 +10,24 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [5.0.0.beta1]
 
-## [4.4.0] - 2021-02-13
+- Update base selenium webdriver version to `4.0.0.beta2`
+- Support only W3C spec
+- Support Ruby 2.5+
+
+## [4.5.0] - 2021-03-14
+
+### Enhancements
+- Add `speed` argument for `Appium::Core::Base::Driver#set_location` since Appium 1.21.0 
+- Add `multiple` and `match_neighbour_threshold` arguments for `Appium::Core::Base::Driver#find_image_occurrence`
+
+### Bug fixes
+
+### Deprecations
+
+
+## [4.4.1(4.4.0)] - 2021-02-15(2021-02-13)
 
 ### Enhancements
 - Returns `{}` any errors in `Core#appium_server_version` to prevent errors in some cases

data/appium_lib_core.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'appium_lib_core/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.name          = 'appium_lib_core'
   spec.version       = Appium::Core::VERSION
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'selenium-webdriver', '~> 3.14', '>= 3.14.1'
+  spec.add_runtime_dependency 'selenium-webdriver', '4.0.0.beta3'
   spec.add_runtime_dependency 'faye-websocket', '~> 0.11.0'
 
   spec.add_development_dependency 'bundler', '>= 1.14'
@@ -30,8 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard', '~> 0.9.11'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
-  spec.add_development_dependency 'webmock', '~> 3.11.0'
-  spec.add_development_dependency 'rubocop', '1.8.1'
+  spec.add_development_dependency 'webmock', '~> 3.12.1'
+  spec.add_development_dependency 'rubocop', '1.12.0'
   spec.add_development_dependency 'appium_thor', '~> 1.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'

data/ci-jobs/functional/run_appium.yml

@@ -1,8 +1,8 @@
 steps:
 - task: NodeTool@0
   inputs:
-    versionSpec: 10.x
-  displayName: Install Node 10.x
+    versionSpec: 12.x
+  displayName: Install Node 12.x
 - script: npm install -g appium@${APPIUM_VERSION}
   displayName: Install appium beta
 - script: npm install -g mjpeg-consumer

data/ci-jobs/functional_test.yml

@@ -4,7 +4,7 @@ parameters:
   vmImageForIOS: 'macOS-10.15' # Not sure the reason, but macOS 10.14 instance raises no info.plist error
   xcodeForIOS: 12.2
   xcodeForTVOS: 12.2
-  androidSDK: 30
+  androidSDK: 29  # API Level 30 emulators are more unstable than 29
   appiumVersion: 'beta'
   ignoreVersionSkip: true
   CI: true

data/lib/appium_lib_core.rb

@@ -17,11 +17,8 @@ require 'selenium-webdriver'
 require_relative 'appium_lib_core/version'
 require_relative 'appium_lib_core/common'
 require_relative 'appium_lib_core/driver'
-
 require_relative 'appium_lib_core/device'
-
-# Call patch after requiring other files
-require_relative 'appium_lib_core/patch'
+require_relative 'appium_lib_core/element'
 
 module Appium
   # convert all keys (including nested) to symbols

data/lib/appium_lib_core/common/base.rb

@@ -34,10 +34,7 @@ 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'

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

@@ -16,52 +16,41 @@ module Appium
   module Core
     class Base
       class Bridge < ::Selenium::WebDriver::Remote::Bridge
+        include Device::DeviceLock
+        include Device::Keyboard
+        include Device::ImeActions
+        include Device::Setting
+        include Device::Context
+        include Device::Value
+        include Device::FileManagement
+        include Device::KeyEvent
+        include Device::ImageComparison
+        include Device::AppManagement
+        include Device::AppState
+        include Device::ScreenRecord::Command
+        include Device::Device
+        include Device::TouchActions
+        include Device::ExecuteDriver
+        include Device::Orientation
+
         # Prefix for extra capability defined by W3C
         APPIUM_PREFIX = 'appium:'
 
-        # TODO: Remove the forceMjsonwp after Appium server won't need it
-        FORCE_MJSONWP = :forceMjsonwp
-
-        # Almost same as self.handshake in ::Selenium::WebDriver::Remote::Bridge
-        #
-        # Implements protocol handshake which:
-        #
-        #   1. Creates session with driver.
-        #   2. Sniffs response.
-        #   3. Based on the response, understands which dialect we should use.
-        #
-        # @return [Bridge::MJSONWP, Bridge::W3C]
-        #
-        def self.handshake(**opts)
-          desired_capabilities = opts.delete(:desired_capabilities) { ::Selenium::WebDriver::Remote::Capabilities.new }
-
-          if desired_capabilities.is_a?(Symbol)
-            unless ::Selenium::WebDriver::Remote::Capabilities.respond_to?(desired_capabilities)
-              raise ::Selenium::WebDriver::Error::WebDriverError, "invalid desired capability: #{desired_capabilities.inspect}"
-            end
-
-            desired_capabilities = ::Selenium::WebDriver::Remote::Capabilities.__send__(desired_capabilities)
-          end
-
-          bridge = new(opts)
-          capabilities = bridge.create_session(desired_capabilities)
-
-          case bridge.dialect
-          when :oss # for MJSONWP
-            Bridge::MJSONWP.new(capabilities, bridge.session_id, **opts)
-          when :w3c
-            Bridge::W3C.new(capabilities, bridge.session_id, **opts)
-          else
-            raise CoreError, 'cannot understand dialect'
+        # Returns 'unknown' if no specific browser name
+        def browser
+          @browser ||= begin
+            name = @capabilities.browser_name
+            name ? name.tr(' ', '_').downcase.to_sym : 'unknown'
+          rescue KeyError
+            'unknown'
           end
         end
 
         # Override
         # Creates session handling both OSS and W3C dialects.
-        # Copy from Selenium::WebDriver::Remote::Bridge to keep using +merged_capabilities+ for Appium
         #
-        # @param [::Selenium::WebDriver::Remote::W3C::Capabilities, Hash] desired_capabilities A capability
-        # @return [::Selenium::WebDriver::Remote::Capabilities, ::Selenium::WebDriver::Remote::W3C::Capabilities]
+        # @param [::Selenium::WebDriver::Remote::Capabilities, Hash] desired_capabilities A capability
+        # @return [::Selenium::WebDriver::Remote::Capabilities]
         #
         # @example
         #
@@ -79,37 +68,27 @@ module Appium
         #     }
         #   }
         #   core = ::Appium::Core.for(caps)
-        #   driver = core.start_driver #=> driver.dialect == :w3c if the Appium server support W3C.
+        #   driver = core.start_driver
         #
         def create_session(desired_capabilities)
-          response = execute(:new_session, {}, merged_capabilities(desired_capabilities))
+          caps = add_appium_prefix(desired_capabilities)
+          response = execute(:new_session, {}, { capabilities: { firstMatch: [caps] } })
 
           @session_id = response['sessionId']
-          oss_status = response['status'] # for compatibility with Appium 1.7.1-
-          value = response['value']
-
-          if value.is_a?(Hash) # include for W3C format
-            @session_id = value['sessionId'] if value.key?('sessionId')
-
-            if value.key?('capabilities')
-              value = value['capabilities']
-            elsif value.key?('value')
-              value = value['value']
-            end
-          end
+          capabilities = response['capabilities']
 
           raise ::Selenium::WebDriver::Error::WebDriverError, 'no sessionId in returned payload' unless @session_id
 
-          json_create(oss_status, value)
+          @capabilities = json_create(capabilities)
         end
 
         # Append +appium:+ prefix for Appium following W3C spec
         # https://www.w3.org/TR/webdriver/#dfn-validate-capabilities
         #
-        # @param [::Selenium::WebDriver::Remote::W3C::Capabilities, Hash] capabilities A capability
-        # @return [::Selenium::WebDriver::Remote::W3C::Capabilities]
+        # @param [::Selenium::WebDriver::Remote::Capabilities, Hash] capabilities A capability
+        # @return [::Selenium::WebDriver::Remote::Capabilities]
         def add_appium_prefix(capabilities)
-          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.new
+          w3c_capabilities = ::Selenium::WebDriver::Remote::Capabilities.new
 
           capabilities = capabilities.__send__(:capabilities) unless capabilities.is_a?(Hash)
 
@@ -133,56 +112,252 @@ module Appium
         end
 
         def extension_prefix?(capability_name)
-          snake_cased_capability_names = ::Selenium::WebDriver::Remote::W3C::Capabilities::KNOWN.map(&:to_s)
+          snake_cased_capability_names = ::Selenium::WebDriver::Remote::Capabilities::KNOWN.map(&:to_s)
           camel_cased_capability_names = snake_cased_capability_names.map { |v| camel_case(v) }
 
+          # Check 'EXTENSION_CAPABILITY_PATTERN'
           snake_cased_capability_names.include?(capability_name) ||
             camel_cased_capability_names.include?(capability_name) ||
-            capability_name.match(::Selenium::WebDriver::Remote::W3C::Capabilities::EXTENSION_CAPABILITY_PATTERN)
+            capability_name.match(':')
         end
 
-        def json_create(oss_status, value)
-          if oss_status
-            ::Selenium::WebDriver.logger.info 'Detected OSS dialect.'
-            @dialect = :oss
-            ::Selenium::WebDriver::Remote::Capabilities.json_create(value)
-          else
-            ::Selenium::WebDriver.logger.info 'Detected W3C dialect.'
-            @dialect = :w3c
-            ::Selenium::WebDriver::Remote::W3C::Capabilities.json_create(value)
-          end
+        def json_create(value)
+          ::Selenium::WebDriver::Remote::Capabilities.json_create(value)
         end
 
-        def delete_force_mjsonwp(capabilities)
-          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.new
+        public
 
-          capabilities = capabilities.__send__(:capabilities) unless capabilities.is_a?(Hash)
-          capabilities.each do |name, value|
-            next if value.nil?
-            next if value.is_a?(String) && value.empty?
-            next if name == FORCE_MJSONWP
+        def commands(command)
+          ::Appium::Core::Commands::COMMANDS[command]
+        end
+
+        # Returns all available sessions on the Appium server instance
+        def sessions
+          execute :get_all_sessions
+        end
+
+        def status
+          execute :status
+        end
+
+        # Perform touch actions for W3C module.
+        # Generate +touch+ pointer action here and users can use this via +driver.action+
+        # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/W3CActionBuilder.html
+        # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/PointerActions.html
+        # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/KeyActions.html
+        #
+        # 'mouse' action is by default in the Ruby client. Appium server force the +mouse+ action to +touch+ once in
+        # the server side. So we don't consider the case.
+        #
+        # @example
+        #
+        #     element = @driver.find_element(:id, "some id")
+        #     @driver.action.click(element).perform # The 'click' is a part of 'PointerActions'
+        #
+        def action(async = false)
+          # Used for default duration of each touch actions
+          # Override from 250 milliseconds to 50 milliseconds
+          action_builder = super
+          action_builder.default_move_duration = 0.05
+          action_builder
+        end
+
+        # Port from MJSONWP
+        def get_timeouts
+          execute :get_timeouts
+        end
+
+        # Port from MJSONWP
+        def session_capabilities
+          ::Selenium::WebDriver::Remote::Capabilities.json_create execute(:get_capabilities)
+        end
+
+        # Port from MJSONWP
+        def send_keys_to_active_element(key)
+          text = ::Selenium::WebDriver::Keys.encode(key).join('')
+          execute :send_keys_to_active_element, {}, { value: text.split(//) }
+        end
+
+        # For Appium
+        # override
+        def page_source
+          # For W3C
+          # execute_script('var source = document.documentElement.outerHTML;' \
+          # 'if (!source) { source = new XMLSerializer().serializeToString(document); }' \
+          # 'return source;')
+          execute :get_page_source
+        end
 
-            w3c_capabilities[name] = value
+        # For Appium
+        # override
+        def element_displayed?(element)
+          # For W3C
+          # https://github.com/SeleniumHQ/selenium/commit/b618499adcc3a9f667590652c5757c0caa703289
+          # execute_atom :isDisplayed, element
+          execute :is_element_displayed, id: element.ref
+        end
+
+        # For Appium
+        # override
+        def element_attribute(element, name)
+          # For W3C in Selenium Client
+          # execute_atom :getAttribute, element, name
+          execute :get_element_attribute, id: element.ref, name: name
+        end
+
+        # For Appium
+        # override
+        def active_element
+          ::Appium::Core::Element.new self, element_id_from(execute(:get_active_element))
+        end
+        alias switch_to_active_element active_element
+
+        # For Appium
+        # override
+        def find_element_by(how, what, parent = nil)
+          how, what = convert_locators(how, what)
+
+          id = if parent
+                 execute :find_child_element, { id: parent }, { using: how, value: what }
+               else
+                 execute :find_element, {}, { using: how, value: what }
+               end
+          ::Appium::Core::Element.new self, element_id_from(id)
+        end
+
+        # For Appium
+        # override
+        def find_elements_by(how, what, parent = nil)
+          how, what = convert_locators(how, what)
+
+          ids = if parent
+                  execute :find_child_elements, { id: parent }, { using: how, value: what }
+                else
+                  execute :find_elements, {}, { using: how, value: what }
+                end
+
+          ids.map { |id| ::Appium::Core::Element.new self, element_id_from(id) }
+        end
+
+        # For Appium
+        # @param [Hash] id The id which can get as a response from server
+        # @return [::Appium::Core::Element]
+        def convert_to_element(id)
+          ::Appium::Core::Element.new self, element_id_from(id)
+        end
+
+        # For Appium
+        # override
+        # called in 'extend DriverExtensions::HasNetworkConnection'
+        def network_connection
+          execute :get_network_connection
+        end
+
+        # For Appium
+        # override
+        # called in 'extend DriverExtensions::HasNetworkConnection'
+        def network_connection=(type)
+          execute :set_network_connection, {}, { parameters: { type: type } }
+        end
+
+        # For Appium
+        # No implementation for W3C webdriver module
+        # called in 'extend DriverExtensions::HasLocation'
+        def location
+          obj = execute(:get_location) || {}
+          ::Selenium::WebDriver::Location.new obj['latitude'], obj['longitude'], obj['altitude']
+        end
+
+        # For Appium
+        # No implementation for W3C webdriver module
+        def set_location(lat, lon, alt = 0.0, speed: nil)
+          loc = { latitude: lat, longitude: lon, altitude: alt }
+          loc[:speed] = speed unless speed.nil?
+          execute :set_location, {}, { location: loc }
+        end
+
+        #
+        # logs
+        #
+        # For Appium
+        # No implementation for W3C webdriver module
+        def available_log_types
+          types = execute :get_available_log_types
+          Array(types).map(&:to_sym)
+        end
+
+        # For Appium
+        # No implementation for W3C webdriver module
+        def log(type)
+          data = execute :get_log, {}, { type: type.to_s }
+
+          Array(data).map do |l|
+            begin
+              ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
+            rescue KeyError
+              next
+            end
           end
+        end
 
-          w3c_capabilities
+        # For Appium
+        def log_event(vendor, event)
+          execute :post_log_event, {}, { vendor: vendor, event: event }
         end
 
-        def merged_capabilities(desired_capabilities)
-          force_mjsonwp = desired_capabilities[FORCE_MJSONWP]
-          desired_capabilities = delete_force_mjsonwp(desired_capabilities) unless force_mjsonwp.nil?
+        # For Appium
+        def log_events(type = nil)
+          args = {}
+          args['type'] = type unless type.nil?
 
-          ::Appium::Logger.warn "'forceMjsonwp' no longer works. Sending both W3C and MJSONWP capabilities" if force_mjsonwp
+          execute :get_log_events, {}, args
+        end
+
+        def take_viewport_screenshot
+          execute_script('mobile: viewportScreenshot')
+        end
 
-          new_caps = add_appium_prefix(desired_capabilities)
-          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.from_oss(new_caps)
+        def take_element_screenshot(element)
+          execute :take_element_screenshot, id: element.ref
+        end
+
+        private
+
+        def unwrap_script_result(arg)
+          case arg
+          when Array
+            arg.map { |e| unwrap_script_result(e) }
+          when Hash
+            element_id = element_id_from(arg)
+            return ::Appium::Core::Element.new(self, element_id) if element_id
+
+            arg.each { |k, v| arg[k] = unwrap_script_result(v) }
+          else
+            arg
+          end
+        end
+
+        def element_id_from(id)
+          id['ELEMENT'] || id['element-6066-11e4-a52e-4f735466cecf']
+        end
 
-          {
-            desiredCapabilities: desired_capabilities,
-            capabilities: {
-              firstMatch: [w3c_capabilities]
-            }
-          }
+        # Don't convert locators for Appium Client
+        # TODO: Only for Appium. Ideally, we'd like to keep the selenium-webdriver
+        def convert_locators(how, what)
+          # case how
+          # when 'class name'
+          #   how = 'css selector'
+          #   what = ".#{escape_css(what)}"
+          # when 'id'
+          #   how = 'css selector'
+          #   what = "##{escape_css(what)}"
+          # when 'name'
+          #   how = 'css selector'
+          #   what = "*[name='#{escape_css(what)}']"
+          # when 'tag name'
+          #   how = 'css selector'
+          # end
+          [how, what]
         end
       end # class Bridge
     end # class Base