appium_lib_core 5.0.0.beta1 → 5.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd462f64262abe99f03dd5a421f2a2dd9c8064f1d44eff47bc1872a834793d27
-  data.tar.gz: 1a1ca492c3551d8c992e9f2b740460e67239887400602351423062e49912b73f
+  metadata.gz: fc513ad9f9ba5689303763b09a884af18e1a9eb80e78a6e05cf838551905f732
+  data.tar.gz: 59241d4d8626cf39eeb63a51291f18deca6759bdba95a8e2bb942173e0b5df9e
 SHA512:
-  metadata.gz: d9e4977dfb93ce734c59af5053a6331bfc2038bd3a03757a31fd7e48c3cdcc810204fb6f3027a1120afe91eda31ad61aa504fa25fdf2a2a21d36638c27982f8e
-  data.tar.gz: 3e23c561984a3ad4bf4214aad79fc730f8673d0bc29c81d26ff5143c0dbeb38d6eacc9278ba0caa11e4dfc51f82267f79b97efe6937ad8315c837e64876df162
+  metadata.gz: 867c6a7bfbdf95243fae3a6292f0349bf9bda1fbb83b44cb7d2e12e8f5e0ecb2f41fb6103aeebdcaaded1024cbb16cd2d758d73bef9bf00697325d75b5c2d027
+  data.tar.gz: 345771f473fca33668d101f00be374ebb3b345b6795c5392b9955da73bb45588e5589b70ba8c983ce161e35c311b2f18adfd7bac3a8d816ba93863820b05b4f6

data/CHANGELOG.md

@@ -5,27 +5,34 @@ Read `release_notes.md` for commit level details.
 ## [Unreleased]
 
 ### Enhancements
+- Allow to override an existing method by `Appium::Core::Base::Driver#add_command` since Appium drivers/plugins allow to override them
 
 ### Bug fixes
 
 ### Deprecations
 
-## [5.0.0.beta1]
+## [5.0.0.beta]
 
 - Update base selenium webdriver version to `4.0.0.beta2`
 - Support only W3C spec
 - Support Ruby 2.5+
+- Raises `::Appium::Core::Error::ArgumentError` instead of `ArgumentError` for this library specific argument errors
 
-## [4.5.0] - 2021-03-14
+## [4.7.0] - 2021-07-17
 
 ### 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`
+- Add `satellites` option in `Appium::Core::Base::Driver#set_location`
 
-### Bug fixes
+## [4.6.0] - 2021-06-03
 
-### Deprecations
+### Enhancements
+- Add `Appium::Core::Base::Driver#add_command` to allow you to add your own command
 
+## [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`
 
 ## [4.4.1(4.4.0)] - 2021-02-15(2021-02-13)
 

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/Rakefile

@@ -38,6 +38,7 @@ namespace :test do
   namespace :unit do
     desc('Run all iOS related unit tests in test directory')
     Rake::TestTask.new(:ios) do |t|
+      ENV['UNIT_TEST'] = '1'
       t.libs << 'test'
       t.libs << 'lib'
       t.test_files = FileList['test/unit/ios/**/*_test.rb']
@@ -45,6 +46,7 @@ namespace :test do
 
     desc('Run all Android related unit tests in test directory')
     Rake::TestTask.new(:android) do |t|
+      ENV['UNIT_TEST'] = '1'
       t.libs << 'test'
       t.libs << 'lib'
       t.test_files = FileList['test/unit/android/**/*_test.rb']
@@ -52,6 +54,7 @@ namespace :test do
 
     desc('Run all common related unit tests in test directory')
     Rake::TestTask.new(:common) do |t|
+      ENV['UNIT_TEST'] = '1'
       t.libs << 'test'
       t.libs << 'lib'
       t.test_files = FileList['test/unit/common/**/*_test.rb']
@@ -59,6 +62,7 @@ namespace :test do
 
     desc('Run all Windows related unit tests in test directory')
     Rake::TestTask.new(:windows) do |t|
+      ENV['UNIT_TEST'] = '1'
       t.libs << 'test'
       t.libs << 'lib'
       t.test_files = FileList['test/unit/windows/**/*_test.rb']

data/appium_lib_core.gemspec

@@ -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', '4.0.0.beta2'
+  spec.add_runtime_dependency 'selenium-webdriver', '4.0.0.rc1'
   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.12.1'
-  spec.add_development_dependency 'rubocop', '1.11.0'
+  spec.add_development_dependency 'webmock', '~> 3.14.0'
+  spec.add_development_dependency 'rubocop', '1.12.1'
   spec.add_development_dependency 'appium_thor', '~> 1.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'

data/ci-jobs/functional_test.yml

@@ -103,7 +103,7 @@ jobs:
     - template: ./functional/ios_setup.yml
       parameters:
         xcodeVersion: ${{ parameters.xcodeForIOS }}
-    - script: brew install ffmpeg && brew tap wix/brew && brew install wix/brew/applesimutils
+    - script: brew install ffmpeg && brew tap wix/brew && brew install applesimutils
       displayName: Install ffmpeg and applesimutils
     - template: ./functional/run_appium.yml
     - script: bundle exec rake test:func:ios TESTS=test/functional/ios/ios/mjpeg_server_test.rb,test/functional/ios/ios/mobile_commands_test.rb

data/docs/mobile_command.md

@@ -9,7 +9,7 @@ We can invoke them via `execute_script` command with `mobile:` arguments.
     - https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/android
 - iOS:
     - https://github.com/appium/appium/tree/master/docs/en/writing-running-appium/ios
-    
+
 
 ```ruby
 # Android shell : https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/android/android-shell.md
@@ -28,7 +28,8 @@ To handle it, we would recommend you to handle the error based on the error mess
 
 ```ruby
 error = assert_raises ::Selenium::WebDriver::Error::UnknownError do
-  @driver.execute_script 'mobile: scrollToPage', { element: el.ref, scrollToPage: -100 }
+  _, element_id = el.ref
+  @driver.execute_script 'mobile: scrollToPage', { element: element_id, scrollToPage: -100 }
 end
 assert error.message.include? 'be a non-negative integer'
 ```

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/common/base/bridge.rb

@@ -16,11 +16,40 @@ module Appium
   module Core
     class Base
       class Bridge < ::Selenium::WebDriver::Remote::Bridge
-        # TODO: Move W3C module to here
+        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:'
 
+        # No 'browserName' means the session is native appium connection
+        APPIUM_NATIVE_BROWSER_NAME = 'appium'
+
+        attr_reader :available_commands
+
+        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.
         #
@@ -45,16 +74,16 @@ module Appium
         #   core = ::Appium::Core.for(caps)
         #   driver = core.start_driver
         #
-        def create_session(desired_capabilities)
-          caps = add_appium_prefix(desired_capabilities)
+        def create_session(capabilities)
+          @available_commands = ::Appium::Core::Commands::COMMANDS.dup
+
+          caps = add_appium_prefix(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)
+          @capabilities = json_create(response['capabilities'])
         end
 
         # Append +appium:+ prefix for Appium following W3C spec
@@ -65,7 +94,7 @@ module Appium
         def add_appium_prefix(capabilities)
           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?
@@ -99,6 +128,273 @@ module Appium
         def json_create(value)
           ::Selenium::WebDriver::Remote::Capabilities.json_create(value)
         end
+
+        public
+
+        # command for Appium 2.0.
+        def add_command(method:, url:, name:, &block)
+          ::Appium::Logger.info "Overriding the method '#{name}' for '#{url}'" 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
+
+        # 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
+          _, element_id = element.ref
+          execute :is_element_displayed, id: element_id
+        end
+
+        # For Appium
+        # override
+        def element_attribute(element, name)
+          # For W3C in Selenium Client
+          # execute_atom :getAttribute, element, name
+          _, element_id = element.ref
+          execute :get_element_attribute, id: element_id, 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_ref = [])
+          how, what = convert_locator(how, what)
+
+          return execute_atom(:findElements, Support::RelativeLocator.new(what).as_json).first if how == 'relative'
+
+          parent_type, parent_id = parent_ref
+          id = case parent_type
+               when :element
+                 execute :find_child_element, { id: parent_id }, { using: how, value: what.to_s }
+               when :shadow_root
+                 execute :find_shadow_child_element, { id: parent_id }, { using: how, value: what.to_s }
+               else
+                 execute :find_element, {}, { using: how, value: what.to_s }
+               end
+
+          ::Appium::Core::Element.new self, element_id_from(id)
+        end
+
+        # For Appium
+        # override
+        def find_elements_by(how, what, parent_ref = [])
+          how, what = convert_locator(how, what)
+
+          return execute_atom :findElements, Support::RelativeLocator.new(what).as_json if how == 'relative'
+
+          parent_type, parent_id = parent_ref
+          ids = case parent_type
+                when :element
+                  execute :find_child_elements, { id: parent_id }, { using: how, value: what.to_s }
+                when :shadow_root
+                  execute :find_shadow_child_elements, { id: parent_id }, { using: how, value: what.to_s }
+                else
+                  execute :find_elements, {}, { using: how, value: what.to_s }
+                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, satellites: nil)
+          loc = { latitude: lat, longitude: lon, altitude: alt }
+          loc[:speed] = speed unless speed.nil?
+          loc[:satellites] = satellites unless satellites.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
+
+        # 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 viewport_screenshot
+          execute_script('mobile: viewportScreenshot')
+        end
+
+        def element_screenshot(element_id)
+          execute :take_element_screenshot, id: element_id
+        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
+
+        # 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
   end # module Core