add support for is keyboard shown command

jlipps · jlipps · commit 75477dc8b380 · 2018-06-12T17:03:41.000-07:00
diff --git a/appium/webdriver/mobilecommand.py b/appium/webdriver/mobilecommand.py
@@ -59,6 +59,7 @@ class MobileCommand(object):
     TOGGLE_TOUCH_ID_ENROLLMENT = 'toggleTouchIdEnrollment'
     RESET = 'reset'
     HIDE_KEYBOARD = 'hideKeyboard'
+    IS_KEYBOARD_SHOWN = 'isKeyboardShown'
     REPLACE_KEYS = 'replaceKeys'
     START_ACTIVITY = 'startActivity'
     GET_SETTINGS = 'getSettings'
diff --git a/appium/webdriver/webdriver.py b/appium/webdriver/webdriver.py
@@ -615,6 +615,10 @@ def hide_keyboard(self, key_name=None, key=None, strategy=None):
         self.execute(Command.HIDE_KEYBOARD, data)
         return self
 
+    def is_keyboard_shown(self):
+        """Attempts to detect whether a software keyboard is present"""
+        return self.execute(Command.IS_KEYBOARD_SHOWN)['value']
+
     # Needed for Selendroid
     def keyevent(self, keycode, metastate=None):
         """Sends a keycode to the device. Android only. Possible keycodes can be
@@ -1438,6 +1442,8 @@ def _addCommands(self):
             ('POST', '/session/$sessionId/appium/app/reset')
         self.command_executor._commands[Command.HIDE_KEYBOARD] = \
             ('POST', '/session/$sessionId/appium/device/hide_keyboard')
+        self.command_executor._commands[Command.IS_KEYBOARD_SHOWN] = \
+            ('GET', '/session/$sessionId/appium/device/is_keyboard_shown')
         self.command_executor._commands[Command.OPEN_NOTIFICATIONS] = \
             ('POST', '/session/$sessionId/appium/device/open_notifications')
         self.command_executor._commands[Command.GET_NETWORK_CONNECTION] = \
diff --git a/test/functional/ios/appium_tests.py b/test/functional/ios/appium_tests.py
@@ -116,6 +116,16 @@ def test_hide_keyboard_no_key_name(self):
         # currently fails.
         self.assertFalse(el.is_displayed())
 
+    def test_is_keyboard_shown(self):
+        self.assertFalse(self.driver.is_keyboard_shown())
+        el = self.driver.find_element_by_name('Uses of UITextField')
+        el.click()
+
+        # get focus on text field, so keyboard comes up
+        el = self.driver.find_element_by_class_name('UIATextField')
+        el.set_value('Testing')
+        self.assertTrue(self.driver.is_keyboard_shown())
+
     def test_clear(self):
         # Click text fields
         self.driver.find_element_by_accessibility_id('TextFields').click()
