Added format to device_time as argument (appium#312)

ki4070ma · mykola-mokhnach · commit fe4344f1ce6a · 2019-01-10T19:08:33.000+01:00
diff --git a/appium/webdriver/mobilecommand.py b/appium/webdriver/mobilecommand.py
@@ -67,7 +67,8 @@ class MobileCommand(object):
     UPDATE_SETTINGS = 'updateSettings'
     SET_LOCATION = 'setLocation'
     GET_LOCATION = 'getLocation'
-    GET_DEVICE_TIME = 'getDeviceTime'
+    GET_DEVICE_TIME_GET = 'getDeviceTimeGet'
+    GET_DEVICE_TIME_POST = 'getDeviceTimePost'
     CLEAR = 'clear'
     START_RECORDING_SCREEN = 'startRecordingScreen'
     STOP_RECORDING_SCREEN = 'stopRecordingScreen'
diff --git a/appium/webdriver/webdriver.py b/appium/webdriver/webdriver.py
@@ -523,9 +523,26 @@ def update_settings(self, settings):
 
     @property
     def device_time(self):
-        """Returns the date and time from the device
+        """Returns the date and time from the device.
         """
-        return self.execute(Command.GET_DEVICE_TIME, {})['value']
+        return self.execute(Command.GET_DEVICE_TIME_GET, {})['value']
+
+    def get_device_time(self, format=None):
+        """Returns the date and time from the device. (Only available since Appium 1.11.0)
+
+        :Args:
+         - format - (optional) The set of format specifiers. Read https://momentjs.com/docs/
+           to get the full list of supported datetime format specifiers.
+           If unset, return :func:`.device_time` as default format is `YYYY-MM-DDTHH:mm:ssZ`,
+           which complies to ISO-8601
+
+        :Usage:
+            self.driver.get_device_time()
+            self.driver.get_device_time("YYYY-MM-DD")
+        """
+        if format is None:
+            return self.device_time
+        return self.execute(Command.GET_DEVICE_TIME_POST, {'format': format})['value']
 
     @property
     def battery_info(self):
@@ -584,7 +601,9 @@ def _addCommands(self):
             ('POST', '/session/$sessionId/appium/settings')
         self.command_executor._commands[Command.LOCATION_IN_VIEW] = \
             ('GET', '/session/$sessionId/element/$id/location_in_view')
-        self.command_executor._commands[Command.GET_DEVICE_TIME] = \
+        self.command_executor._commands[Command.GET_DEVICE_TIME_GET] = \
             ('GET', '/session/$sessionId/appium/device/system_time')
+        self.command_executor._commands[Command.GET_DEVICE_TIME_POST] = \
+            ('POST', '/session/$sessionId/appium/device/system_time')
         self.command_executor._commands[Command.CLEAR] = \
             ('POST', '/session/$sessionId/element/$id/clear')
diff --git a/test/unit/webdriver/device/device_time_test.py b/test/unit/webdriver/device/device_time_test.py
@@ -15,6 +15,7 @@
 from test.unit.helper.test_helper import appium_command, android_w3c_driver
 
 import httpretty
+import json
 
 
 class TestWebDriverDeviceLock(object):
@@ -28,3 +29,26 @@ def test_device_time(self):
             body='{"value": "2019-01-05T14:46:44+09:00"}'
         )
         assert driver.device_time == '2019-01-05T14:46:44+09:00'
+
+    @httpretty.activate
+    def test_get_device_time(self):
+        driver = android_w3c_driver()
+        httpretty.register_uri(
+            httpretty.GET,
+            appium_command('/session/1234567890/appium/device/system_time'),
+            body='{"value": "2019-01-05T14:46:44+09:00"}'
+        )
+        assert driver.get_device_time() == '2019-01-05T14:46:44+09:00'
+
+    @httpretty.activate
+    def test_get_formatted_device_time(self):
+        driver = android_w3c_driver()
+        httpretty.register_uri(
+            httpretty.POST,
+            appium_command('/session/1234567890/appium/device/system_time'),
+            body='{"value": "2019-01-08"}'
+        )
+        assert driver.get_device_time('YYYY-MM-DD') == '2019-01-08'
+
+        d = json.loads(httpretty.last_request().body.decode('utf-8'))
+        assert d['format'] == 'YYYY-MM-DD'
