appium_lib_core 4.3.0 → 5.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc629c2d452b2bf40d98f09b53e76d4018d54ebda9ef8f0f0004677e6392ea42
-  data.tar.gz: e0b6de5e05f066b40752eb148c791832283f9e9ac1d54c1bd3a804c2d5a6f3aa
+  metadata.gz: fd462f64262abe99f03dd5a421f2a2dd9c8064f1d44eff47bc1872a834793d27
+  data.tar.gz: 1a1ca492c3551d8c992e9f2b740460e67239887400602351423062e49912b73f
 SHA512:
-  metadata.gz: 2cc700ab57cdbc85c3c1f216f5f003c4453be55b148f39deffe9aee83cdae369b75cf150103f5035e93a7804dda13d60996aa891ccbd7bb3cb6e7927fec0dc6f
-  data.tar.gz: 0d0f0368958648b5799d13bc2c2d10ea45e27a583caf41a81d38dfc9eeb2a3d02909396b1623fe7ef37e116bf581296a37eac8422256f3e76c1c4a576d7e9786
+  metadata.gz: d9e4977dfb93ce734c59af5053a6331bfc2038bd3a03757a31fd7e48c3cdcc810204fb6f3027a1120afe91eda31ad61aa504fa25fdf2a2a21d36638c27982f8e
+  data.tar.gz: 3e23c561984a3ad4bf4214aad79fc730f8673d0bc29c81d26ff5143c0dbeb38d6eacc9278ba0caa11e4dfc51f82267f79b97efe6937ad8315c837e64876df162

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "11:00"
+  open-pull-requests-limit: 10

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,15 +10,33 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
-## [4.3.0] - 2021-02-05
+## [5.0.0.beta1]
+
+- 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 `start_recording_screen` for Mac2 driver
+- 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
+
+## [4.3.1(4.3.0)] - 2021-02-07(2021-02-05)
+
+### Enhancements
+- Add `start_recording_screen` for Mac2 driver
+
 ## [4.2.1] - 2021-01-10
 
 ### Enhancements

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.beta2'
   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.11.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/common/base.rb

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

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

@@ -16,52 +16,16 @@ module Appium
   module Core
     class Base
       class Bridge < ::Selenium::WebDriver::Remote::Bridge
+        # TODO: Move W3C module to here
+
         # 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'
-          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 +43,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 +87,17 @@ 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
-        end
-
-        def delete_force_mjsonwp(capabilities)
-          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.new
-
-          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
-
-            w3c_capabilities[name] = value
-          end
-
-          w3c_capabilities
-        end
-
-        def merged_capabilities(desired_capabilities)
-          force_mjsonwp = desired_capabilities[FORCE_MJSONWP]
-          desired_capabilities = delete_force_mjsonwp(desired_capabilities) unless force_mjsonwp.nil?
-
-          ::Appium::Logger.warn "'forceMjsonwp' no longer works. Sending both W3C and MJSONWP capabilities" if force_mjsonwp
-
-          new_caps = add_appium_prefix(desired_capabilities)
-          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.from_oss(new_caps)
-
-          {
-            desiredCapabilities: desired_capabilities,
-            capabilities: {
-              firstMatch: [w3c_capabilities]
-            }
-          }
+        def json_create(value)
+          ::Selenium::WebDriver::Remote::Capabilities.json_create(value)
         end
       end # class Bridge
     end # class Base

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

@@ -16,7 +16,7 @@ module Appium
   module Core
     class Base
       class Bridge
-        class W3C < ::Selenium::WebDriver::Remote::W3C::Bridge
+        class W3C < ::Selenium::WebDriver::Remote::Bridge
           include Device::DeviceLock
           include Device::Keyboard
           include Device::ImeActions
@@ -34,6 +34,106 @@ module Appium
           include Device::ExecuteDriver
           include Device::Orientation
 
+          # TODO: For compatibility. Should remove.
+          def dialect
+            :w3c
+          end
+
+          # TODO: fixme
+          def browser
+            @browser ||= begin
+              name = @capabilities.browser_name
+              name ? name.tr(' ', '_').downcase.to_sym : 'unknown'
+            rescue KeyError
+              'unknown'
+            end
+          end
+
+          # Prefix for extra capability defined by W3C
+          APPIUM_PREFIX = 'appium:'
+
+          # Override
+          # Creates session handling both OSS and W3C dialects.
+          #
+          # @param [::Selenium::WebDriver::Remote::Capabilities, Hash] desired_capabilities A capability
+          # @return [::Selenium::WebDriver::Remote::Capabilities]
+          #
+          # @example
+          #
+          #   opts = {
+          #     caps: {
+          #       platformName: :ios,
+          #       automationName: 'XCUITest',
+          #       app: 'test/functional/app/UICatalog.app.zip',
+          #       platformVersion: '11.4',
+          #       deviceName: 'iPhone Simulator',
+          #       useNewWDA: true,
+          #     },
+          #     appium_lib: {
+          #       wait: 30
+          #     }
+          #   }
+          #   core = ::Appium::Core.for(caps)
+          #   driver = core.start_driver #=> driver.dialect == :w3c if the Appium server support W3C.
+          #
+          def create_session(desired_capabilities)
+            caps = add_appium_prefix(desired_capabilities)
+            response = execute(:new_session, {}, { capabilities: { firstMatch: [caps] } })
+
+            @session_id = response['sessionId']
+            capabilities = response['capabilities']
+
+            raise ::Selenium::WebDriver::Error::WebDriverError, 'no sessionId in returned payload' unless @session_id
+
+            @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::Capabilities, Hash] capabilities A capability
+          # @return [::Selenium::WebDriver::Remote::Capabilities]
+          def add_appium_prefix(capabilities)
+            w3c_capabilities = ::Selenium::WebDriver::Remote::Capabilities.new
+
+            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?
+
+              capability_name = name.to_s
+              w3c_name = extension_prefix?(capability_name) ? name : "#{APPIUM_PREFIX}#{capability_name}"
+
+              w3c_capabilities[w3c_name] = value
+            end
+
+            w3c_capabilities
+          end
+
+          private
+
+          def camel_case(str)
+            str.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
+          end
+
+          def extension_prefix?(capability_name)
+            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(':')
+          end
+
+          def json_create(value)
+            @dialect = :w3c
+            ::Selenium::WebDriver::Remote::Capabilities.json_create(value)
+          end
+
+          public
+
           def commands(command)
             ::Appium::Core::Commands::W3C::COMMANDS[command]
           end
@@ -43,6 +143,10 @@ module Appium
             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
@@ -72,7 +176,7 @@ module Appium
 
           # Port from MJSONWP
           def session_capabilities
-            ::Selenium::WebDriver::Remote::W3C::Capabilities.json_create execute(:get_capabilities)
+            ::Selenium::WebDriver::Remote::Capabilities.json_create execute(:get_capabilities)
           end
 
           # Port from MJSONWP
@@ -166,18 +270,9 @@ module Appium
 
           # For Appium
           # No implementation for W3C webdriver module
-          # called in +extend DriverExtensions::HasLocation+
-          # It has below code as well. We should consider the same context in Selenium 4 as backward compatibility.
-          #
-          #     def location=(loc)
-          #       # note: Location  = Struct.new(:latitude, :longitude, :altitude)
-          #       raise TypeError, "expected #{Location}, got #{loc.inspect}:#{loc.class}" unless loc.is_a?(Location)
-          #
-          #       @bridge.set_location loc.latitude, loc.longitude, loc.altitude
-          #     end
-          #
-          def set_location(lat, lon, alt = 0.0)
+          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