feat: Add optional location speed attribute for android devices (appium#594)

salabogdan · web-flow · commit ce78c0de2e15 · 2021-03-10T14:46:18.000+01:00
diff --git a/appium/webdriver/extensions/location.py b/appium/webdriver/extensions/location.py
@@ -38,14 +38,19 @@ def toggle_location_services(self: T) -> T:
         return self
 
     def set_location(
-        self: T, latitude: Union[float, str], longitude: Union[float, str], altitude: Union[float, str] = None
+        self: T,
+        latitude: Union[float, str],
+        longitude: Union[float, str],
+        altitude: Union[float, str] = None,
+        speed: Union[float, str] = None,
     ) -> T:
         """Set the location of the device
 
         Args:
             latitude: String or numeric value between -90.0 and 90.00
             longitude: String or numeric value between -180.0 and 180.0
             altitude: String or numeric value (Android real device only)
+            speed: String or numeric value larger than 0.0 (Android real devices only)
 
         Returns:
             Union['WebDriver', 'Location']: Self instance
@@ -58,6 +63,8 @@ def set_location(
         }
         if altitude is not None:
             data['location']['altitude'] = altitude
+        if speed is not None:
+            data['location']['speed'] = speed
         self.execute(Command.SET_LOCATION, data)
         return self
 
diff --git a/test/unit/webdriver/device/location_test.py b/test/unit/webdriver/device/location_test.py
@@ -33,35 +33,50 @@ def test_toggle_location_services(self):
     def test_set_location_float(self):
         driver = android_w3c_driver()
         httpretty.register_uri(httpretty.POST, appium_command('/session/1234567890/location'))
-        assert isinstance(driver.set_location(11.1, 22.2, 33.3), WebDriver)
+        assert isinstance(driver.set_location(11.1, 22.2, 33.3, 23.2), WebDriver)
 
         d = get_httpretty_request_body(httpretty.last_request())
         assert abs(d['location']['latitude'] - 11.1) <= FLT_EPSILON
         assert abs(d['location']['longitude'] - 22.2) <= FLT_EPSILON
         assert abs(d['location']['altitude'] - 33.3) <= FLT_EPSILON
+        assert abs(d['location']['speed'] - 23.2) <= FLT_EPSILON
 
     @httpretty.activate
     def test_set_location_str(self):
         driver = android_w3c_driver()
         httpretty.register_uri(httpretty.POST, appium_command('/session/1234567890/location'))
-        assert isinstance(driver.set_location('11.1', '22.2', '33.3'), WebDriver)
+        assert isinstance(driver.set_location('11.1', '22.2', '33.3', '23.2'), WebDriver)
 
         d = get_httpretty_request_body(httpretty.last_request())
         assert d['location']['latitude'] == '11.1'
         assert d['location']['longitude'] == '22.2'
         assert d['location']['altitude'] == '33.3'
+        assert d['location']['speed'] == '23.2'
 
     @httpretty.activate
     def test_set_location_without_altitude(self):
         driver = android_w3c_driver()
         httpretty.register_uri(httpretty.POST, appium_command('/session/1234567890/location'))
-        assert isinstance(driver.set_location(11.1, 22.2), WebDriver)
+        assert isinstance(driver.set_location(11.1, 22.2, speed=23.2), WebDriver)
 
         d = get_httpretty_request_body(httpretty.last_request())
         assert abs(d['location']['latitude'] - 11.1) <= FLT_EPSILON
         assert abs(d['location']['longitude'] - 22.2) <= FLT_EPSILON
+        assert abs(d['location']['speed'] - 23.2) <= FLT_EPSILON
         assert d['location'].get('altitude') is None
 
+    @httpretty.activate
+    def test_set_location_without_speed(self):
+        driver = android_w3c_driver()
+        httpretty.register_uri(httpretty.POST, appium_command('/session/1234567890/location'))
+        assert isinstance(driver.set_location(11.1, 22.2, 33.3), WebDriver)
+
+        d = get_httpretty_request_body(httpretty.last_request())
+        assert abs(d['location']['latitude'] - 11.1) <= FLT_EPSILON
+        assert abs(d['location']['longitude'] - 22.2) <= FLT_EPSILON
+        assert abs(d['location']['altitude'] - 33.3) <= FLT_EPSILON
+        assert d['location'].get('speed') is None
+
     @httpretty.activate
     def test_location(self):
         driver = android_w3c_driver()
