appium_lib_core 4.1.0 → 5.0.0.beta4

data/README.md

@@ -11,6 +11,7 @@ This library wraps [selenium-webdriver](https://github.com/SeleniumHQ/selenium/w
 # Documentation
 
 - http://www.rubydoc.info/github/appium/ruby_lib_core
+    - You can find working API examples in test code, [test/functional](test/functional)
 
 # Related library
 - https://github.com/appium/ruby_lib
@@ -120,7 +121,7 @@ $ IGNORE_VERSION_SKIP=true CI=true bundle exec rake test:func:android
     $ ruby test.rb
     ```
 
-More examples are in [test/functional](test/functional)    
+More examples are in [test/functional](test/functional)
 
 ### Capabilities
 

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.beta4'
   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.7.0'
+  spec.add_development_dependency 'webmock', '~> 3.13.0'
+  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/android/device/auth_finger_print.rb

@@ -21,7 +21,8 @@ module Appium
             ::Appium::Core::Device.add_endpoint_method(:finger_print) do
               def finger_print(finger_id)
                 unless (1..10).cover? finger_id.to_i
-                  raise ArgumentError, "finger_id should be integer between 1 to 10. Not #{finger_id}"
+                  raise ::Appium::Core::Error::ArgumentError,
+                        "finger_id should be integer between 1 to 10. Not #{finger_id}"
                 end
 
                 execute(:finger_print, {}, { fingerprintId: finger_id.to_i })

data/lib/appium_lib_core/android/device.rb

@@ -290,16 +290,16 @@ module Appium
         #   @driver.finger_print 1
         #
 
-        # @!method execute_cdp(cmd, params)
+        # @!method execute_cdp(cmd, **params)
         #     Execute Chrome Devtools protocol commands
         #     https://chromedevtools.github.io/devtools-protocol
         #
         # @param [String] cmd The name of command
-        # @param [Hash] params The parameter for the command as hash.
+        # @option params The parameter for the command as keyword options.
         #
         # @example
         #
-        #   @driver.execute_cdp 'Page.captureScreenshot', { quality: 50, format: 'jpeg' }
+        #   @driver.execute_cdp 'Page.captureScreenshot', quality: 50, format: 'jpeg'
         #   @driver.execute_cdp 'Page.getResourceTree'
         #
 
@@ -415,7 +415,7 @@ module Appium
               # SeleniumWebdriver could already define this method
               return if method_defined? :execute_cdp
 
-              def execute_cdp(cmd, params = {})
+              def execute_cdp(cmd, **params)
                 execute :chrome_send_command, {}, { cmd: cmd, params: params }
               end
             end

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

@@ -16,52 +16,45 @@ 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
+        # No 'browserName' means the session is native appium connection
+        APPIUM_NATIVE_BROWSER_NAME = 'appium'
 
-        # 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 }
+        attr_reader :available_commands
 
-          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'
+        def browser
+          @browser ||= begin
+            name = @capabilities.browser_name
+            name ? name.tr(' ', '_').downcase.to_sym : 'unknown'
+          rescue KeyError
+            APPIUM_NATIVE_BROWSER_NAME
           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,39 +72,29 @@ 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))
+        def create_session(capabilities)
+          @available_commands = ::Appium::Core::Commands::COMMANDS.dup
 
-          @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
+          caps = add_appium_prefix(capabilities)
+          response = execute(:new_session, {}, { capabilities: { firstMatch: [caps] } })
 
+          @session_id = response['sessionId']
           raise ::Selenium::WebDriver::Error::WebDriverError, 'no sessionId in returned payload' unless @session_id
 
-          json_create(oss_status, value)
+          @capabilities = json_create(response['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)
+          capabilities = capabilities.send(:capabilities) unless capabilities.is_a?(Hash)
 
           capabilities.each do |name, value|
             next if value.nil?
@@ -133,56 +116,268 @@ 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
+        # command for Appium 2.0.
+        def add_command(method:, url:, name:, &block)
+          raise ::Appium::Core::Error::ArgumentError, "#{name} is already defined" if @available_commands.key? name
+
+          @available_commands[name] = [method, url]
+
+          ::Appium::Core::Device.add_endpoint_method name, &block
+        end
+
+        def commands(command)
+          @available_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
 
-            w3c_capabilities[name] = value
+        # 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
+
+        # 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_locator(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_locator(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
+
+        # For Appium
+        def log_events(type = nil)
+          args = {}
+          args['type'] = type unless type.nil?
+
+          execute :get_log_events, {}, args
+        end
+
+        def take_viewport_screenshot
+          execute_script('mobile: viewportScreenshot')
         end
 
-        def merged_capabilities(desired_capabilities)
-          force_mjsonwp = desired_capabilities[FORCE_MJSONWP]
-          desired_capabilities = delete_force_mjsonwp(desired_capabilities) unless force_mjsonwp.nil?
+        def take_element_screenshot(element)
+          execute :take_element_screenshot, id: element.ref
+        end
+
+        private
 
-          ::Appium::Logger.warn "'forceMjsonwp' no longer works. Sending both W3C and MJSONWP capabilities" if force_mjsonwp
+        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
 
-          new_caps = add_appium_prefix(desired_capabilities)
-          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.from_oss(new_caps)
+            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 in native context
+        def convert_locator(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
+          #
+          # if what.is_a?(Hash)
+          #   what = what.each_with_object({}) do |(h, w), hash|
+          #     h, w = convert_locator(h.to_s, w)
+          #     hash[h] = w
+          #   end
+          # end
+
+          [how, what]
         end
       end # class Bridge
     end # class Base

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

@@ -19,10 +19,10 @@ module Appium
         # @private
         # @param [Hash] opts_caps Capabilities for Appium server. All capability keys are converted to lowerCamelCase when
         #                         this client sends capabilities to Appium server as JSON format.
-        # @return [::Selenium::WebDriver::Remote::W3C::Capabilities] Return instance of Appium::Core::Base::Capabilities
-        #                         inherited ::Selenium::WebDriver::Remote::W3C::Capabilities
+        # @return [::Selenium::WebDriver::Remote::Capabilities] Return instance of Appium::Core::Base::Capabilities
+        #                         inherited ::Selenium::WebDriver::Remote::Capabilities
         def self.create_capabilities(opts_caps = {})
-          ::Selenium::WebDriver::Remote::W3C::Capabilities.new(opts_caps)
+          ::Selenium::WebDriver::Remote::Capabilities.new(opts_caps)
         end
       end
     end

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

@@ -0,0 +1,49 @@
+# 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 DeviceIME
+        # @private this class is private
+        def initialize(bridge)
+          @bridge = bridge
+        end
+
+        def activate(ime_name)
+          @bridge.ime_activate(ime_name)
+        end
+
+        def available_engines
+          @bridge.ime_available_engines
+        end
+
+        def active_engine
+          @bridge.ime_active_engine
+        end
+
+        def activated?
+          @bridge.ime_activated
+        end
+
+        def deactivate
+          @bridge.ime_deactivate
+        end
+      end
+    end
+  end
+end