Merge pull request #32 from appium/isaac-hidekeyboard

Add strategy to hide_keyboard

Author: jlipps

appium/webdriver/webdriver.py

@@ -329,14 +329,23 @@ def reset(self):
         self.execute(Command.RESET)
         return self
 
-    def hide_keyboard(self, key_name=None):
-        """Hides the software keyboard on the device, using the specified key to
-        press. If no key name is given, the keyboard is closed by moving focus
-        from the text field. iOS only.
+    def hide_keyboard(self, key_name=None, key=None, strategy=None):
+        """Hides the software keyboard on the device. In iOS, use `key_name` to press
+        a particular key, or `strategy`. In Android, no parameters are used.
+
+        :Args:
+         - key_name - key to press
+         - strategy - strategy for closing the keyboard (e.g., `tapOutside`)
         """
         data = {}
         if key_name is not None:
             data['keyName'] = key_name
+        elif key is not None:
+            data['key'] = key
+        else:
+            # defaults to `tapOutside` strategy
+            strategy = 'tapOutside'
+        data['strategy'] = strategy
         self.execute(Command.HIDE_KEYBOARD, data)
         return self
 

test/functional/ios/appium_tests.py

@@ -55,7 +55,22 @@ def test_hide_keyboard(self):
         el = self.driver.find_element_by_class_name('UIAKeyboard')
         self.assertTrue(el.is_displayed())
 
-        self.driver.hide_keyboard('Done')
+        self.driver.hide_keyboard(key_name='Done')
+
+        self.assertFalse(el.is_displayed())
+
+    def test_hide_keyboard_presskey_strategy(self):
+        el = self.driver.find_element_by_name('TextFields, 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')
+
+        el = self.driver.find_element_by_class_name('UIAKeyboard')
+        self.assertTrue(el.is_displayed())
+
+        self.driver.hide_keyboard(strategy='pressKey', key='Done')
 
         self.assertFalse(el.is_displayed())
 
@@ -78,4 +93,5 @@ def test_hide_keyboard_no_key_name(self):
 
 
 if __name__ == "__main__":
-    unittest.main()
+    suite = unittest.TestLoader().loadTestsFromTestCase(AppiumTests)
+    unittest.TextTestRunner(verbosity=2).run(suite)

test/functional/ios/desired_capabilities.py

@@ -22,6 +22,8 @@
 
 def get_desired_capabilities(app):
     desired_caps = {
+        'deviceName': 'iPhone Simulator',
+        'platformName': 'iOS',
         'app': PATH('../../apps/' + app),
     }