Merge pull request #38 from appium/isaac-ime

Add methods for Android ime access

Author: jlipps

appium/webdriver/mobilecommand.py

@@ -20,6 +20,13 @@ class MobileCommand(object):
     TOUCH_ACTION = 'touchAction'
     MULTI_ACTION = 'multiAction'
     OPEN_NOTIFICATIONS = 'openNotifications'
+    GET_NETWORK_CONNECTION = 'getNetworkConnection'
+    SET_NETWORK_CONNECTION = 'setNetworkConnection'
+    GET_AVAILABLE_IME_ENGINES = 'getAvailableIMEEngines'
+    IS_IME_ACTIVE = 'isIMEActive'
+    ACTIVATE_IME_ENGINE = 'activateIMEEngine'
+    DEACTIVATE_IME_ENGINE = 'deactivateIMEEngine'
+    GET_ACTIVE_IME_ENGINE = 'getActiveEngine'
 
     # Appium Commands
     GET_APP_STRINGS = 'getAppStrings'
@@ -44,5 +51,3 @@ class MobileCommand(object):
     SHAKE = 'shake'
     RESET = 'reset'
     HIDE_KEYBOARD = 'hideKeyboard'
-    GET_NETWORK_CONNECTION = 'getNetworkConnection'
-    SET_NETWORK_CONNECTION = 'setNetworkConnection'

appium/webdriver/webdriver.py

@@ -600,6 +600,50 @@ def set_network_connection(self, connectionType):
         }
         return self.execute(Command.SET_NETWORK_CONNECTION, data)['value']
 
+    @property
+    def available_ime_engines(self):
+        """Get the available input methods for an Android device. Package and
+        activity are returned (e.g., ['com.android.inputmethod.latin/.LatinIME'])
+        Android only.
+        """
+        return self.execute(Command.GET_AVAILABLE_IME_ENGINES, {})['value']
+
+    def is_ime_active(self):
+        """Checks whether the device has IME service active. Returns True/False.
+        Android only.
+        """
+        return self.execute(Command.IS_IME_ACTIVE, {})['value']
+
+    def activate_ime_engine(self, engine):
+        """Activates the given IME engine on the device.
+        Android only.
+
+        :Args:
+         - engine - the package and activity of the IME engine to activate (e.g.,
+            'com.android.inputmethod.latin/.LatinIME')
+        """
+        data = {
+            'engine': engine
+        }
+        self.execute(Command.ACTIVATE_IME_ENGINE, data)
+        return self
+
+    def deactivate_ime_engine(self):
+        """Deactivates the currently active IME engine on the device.
+        Android only.
+        """
+        self.execute(Command.DEACTIVATE_IME_ENGINE, {})
+        return self
+
+    @property
+    def active_ime_engine(self):
+        """Returns the activity and package of the currently active IME engine (e.g.,
+        'com.android.inputmethod.latin/.LatinIME').
+        Android only.
+        """
+        return self.execute(Command.GET_ACTIVE_IME_ENGINE, {})['value']
+
+
     def _addCommands(self):
         self.command_executor._commands[Command.CONTEXTS] = \
             ('GET', '/session/$sessionId/contexts')
@@ -660,6 +704,16 @@ def _addCommands(self):
             ('GET', '/session/$sessionId/network_connection')
         self.command_executor._commands[Command.SET_NETWORK_CONNECTION] = \
             ('POST', '/session/$sessionId/network_connection')
+        self.command_executor._commands[Command.GET_AVAILABLE_IME_ENGINES] = \
+            ('GET', '/session/$sessionId/ime/available_engines')
+        self.command_executor._commands[Command.IS_IME_ACTIVE] = \
+            ('GET', '/session/$sessionId/ime/activated')
+        self.command_executor._commands[Command.ACTIVATE_IME_ENGINE] = \
+            ('POST', '/session/$sessionId/ime/activate')
+        self.command_executor._commands[Command.DEACTIVATE_IME_ENGINE] = \
+            ('POST', '/session/$sessionId/ime/deactivate')
+        self.command_executor._commands[Command.GET_ACTIVE_IME_ENGINE] = \
+            ('GET', '/session/$sessionId/ime/active_engine')
 
 
 # monkeypatched method for WebElement

test/functional/android/ime_tests.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# 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.
+
+import unittest
+from time import sleep
+
+from selenium.common.exceptions import NoSuchElementException
+
+from appium import webdriver
+import desired_capabilities
+
+
+# the emulator is sometimes slow and needs time to think
+SLEEPY_TIME = 1
+
+LATIN_IME = u'com.android.inputmethod.latin/.LatinIME'
+
+
+class IMETests(unittest.TestCase):
+    def setUp(self):
+        desired_caps = desired_capabilities.get_desired_capabilities('ApiDemos-debug.apk')
+        self.driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps)
+
+    def tearDown(self):
+        self.driver.quit()
+
+
+    def test_available_ime_engines(self):
+        engines = self.driver.available_ime_engines
+        self.assertIsInstance(engines, list)
+        self.assertTrue(LATIN_IME in engines)
+
+    def test_is_ime_active(self):
+        self.assertTrue(self.driver.is_ime_active())
+
+    def test_active_ime_engine(self):
+        self.assertIsInstance(self.driver.active_ime_engine, unicode)
+
+    def test_activate_ime_engine(self):
+        engines = self.driver.available_ime_engines
+        active_engine = self.driver.active_ime_engine
+
+        self.driver.activate_ime_engine(engines[-1])
+        self.assertEqual(self.driver.active_ime_engine, engines[-1])
+
+    def test_deactivate_ime_engine(self):
+        engines = self.driver.available_ime_engines
+        self.driver.activate_ime_engine(engines[-1])
+
+        self.assertEqual(self.driver.active_ime_engine, engines[-1])
+
+        self.driver.deactivate_ime_engine()
+        sleep(1)
+        self.assertNotEqual(self.driver.active_ime_engine, engines[-1])
+
+
+if __name__ == "__main__":
+    suite = unittest.TestLoader().loadTestsFromTestCase(IMETests)
+    unittest.TextTestRunner(verbosity=2).run(suite)