feat: add speed option (#318)

* add speed option

* tweak docstring

* use android sdk 29 to make the sumulator stable

* add note

Author: KazuCocoa

CHANGELOG.md

@@ -5,6 +5,7 @@ Read `release_notes.md` for commit level details.
 ## [Unreleased]
 
 ### Enhancements
+- Add `speed` argument for `ppium::Core::Base::Driver#set_location`
 - Add `multiple` and `match_neighbour_threshold` arguments for `Appium::Core::Base::Driver#find_image_occurrence`
 
 ### Bug fixes

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

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

@@ -78,6 +78,12 @@ def send_actions(_data)
           def convert_to_element(id)
             ::Selenium::WebDriver::Element.new self, element_id_from(id)
           end
+
+          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
         end # class MJSONWP
       end # class Bridge
     end # class Base

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

@@ -170,18 +170,9 @@ def location
 
           # 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
 

lib/appium_lib_core/common/base/driver.rb

@@ -17,6 +17,7 @@
 require_relative 'screenshot'
 require_relative 'rotable'
 require_relative 'remote_status'
+require_relative 'has_location'
 
 module Appium
   module Core
@@ -26,11 +27,14 @@ class Driver < ::Selenium::WebDriver::Driver
         include ::Selenium::WebDriver::DriverExtensions::HasSessionId
         include ::Selenium::WebDriver::DriverExtensions::HasRemoteStatus
         include ::Selenium::WebDriver::DriverExtensions::HasWebStorage
+        include ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection
+        include  ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
 
         include ::Appium::Core::Base::Rotatable
         include ::Appium::Core::Base::SearchContext
         include ::Appium::Core::Base::TakesScreenshot
         include ::Appium::Core::Base::HasRemoteStatus
+        include ::Appium::Core::Base::HasLocation
 
         # Private API.
         # Do not use this for general use. Used by flutter driver to get bridge for creating a new element
@@ -39,16 +43,6 @@ class Driver < ::Selenium::WebDriver::Driver
         def initialize(opts = {})
           listener = opts.delete(:listener)
           @bridge = ::Appium::Core::Base::Bridge.handshake(**opts)
-          if @bridge.dialect == :oss # MJSONWP
-            extend ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
-            extend ::Selenium::WebDriver::DriverExtensions::HasLocation
-            extend ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection
-          elsif @bridge.dialect == :w3c
-            # TODO: Only for Appium. Ideally, we'd like to remove the below like selenium-webdriver
-            extend ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
-            extend ::Selenium::WebDriver::DriverExtensions::HasLocation
-            extend ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection
-          end
           super(@bridge, listener: listener)
         end
 

lib/appium_lib_core/common/base/has_location.rb

@@ -0,0 +1,73 @@
+# 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 [::Selenium::WebDriver::Location]
+        #
+        # @example
+        #
+        #   driver.location #=> ::Selenium::WebDriver::Location.new(10, 10, 10)
+        #
+        def location
+          @bridge.location
+        end
+
+        # Set the location of the device.
+        #
+        # @param [::Selenium::WebDriver::Location] location Set the location.
+        #
+        # @example
+        #
+        #   driver.location = ::Selenium::WebDriver::Location.new(10, 10, 10)
+        #
+        def location=(location)
+          unless location.is_a?(::Selenium::WebDriver::Location)
+            raise TypeError, "expected #{::Selenium::WebDriver::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 @since Appium 1.21.0.
+        # @param [::Selenium::WebDriver::Location]
+        #
+        # @example
+        #
+        #   driver.location = ::Selenium::WebDriver::Location.new(10, 10, 10)
+        #
+        def set_location(latitude, longitude, altitude, speed: nil)
+          if speed.nil?
+            self.location = ::Selenium::WebDriver::Location.new(Float(latitude), Float(longitude), Float(altitude))
+          else
+            loc = ::Selenium::WebDriver::Location.new(Float(latitude), Float(longitude), Float(altitude))
+            @bridge.set_location loc.latitude, loc.longitude, loc.altitude, speed: Float(speed)
+          end
+        end
+      end
+    end
+  end
+end

test/unit/android/webdriver/mjsonwp/commands_test.rb

@@ -102,6 +102,16 @@ def test_set_location
             assert_requested(:post, "#{SESSION}/location", times: 2)
           end
 
+          def test_set_location_speed
+            stub_request(:post, "#{SESSION}/location")
+              .with(body: { location: { latitude: 1.0, longitude: 1.0, altitude: 1.0, speed: 1.0 } }.to_json)
+              .to_return(headers: HEADER, status: 200, body: { value: nil }.to_json)
+
+            @driver.set_location 1, 1, 1, speed: 1
+
+            assert_requested(:post, "#{SESSION}/location", times: 1)
+          end
+
           def test_rotate
             stub_request(:post, "#{SESSION}/orientation")
               .to_return(headers: HEADER, status: 200, body: { value: 'xxxx' }.to_json)

test/unit/android/webdriver/w3c/commands_test.rb

@@ -96,6 +96,16 @@ def test_set_location
             assert_requested(:post, "#{SESSION}/location", times: 2)
           end
 
+          def test_set_location_speed
+            stub_request(:post, "#{SESSION}/location")
+              .with(body: { location: { latitude: 1.0, longitude: 1.0, altitude: 1.0, speed: 1.0 } }.to_json)
+              .to_return(headers: HEADER, status: 200, body: { value: nil }.to_json)
+
+            @driver.set_location 1, 1, 1, speed: 1
+
+            assert_requested(:post, "#{SESSION}/location", times: 1)
+          end
+
           def test_rotate
             stub_request(:post, "#{SESSION}/orientation")
               .to_return(headers: HEADER, status: 200, body: { value: 'xxxx' }.to_json)