Merge pull request appium#3 from appium/isaac-android-uiautomator

jlipps · jlipps · commit e76c39efa097 · 2014-04-09T14:52:44.000-07:00
Add Android UIAutomator locator strategy
diff --git a/README.md b/README.md
@@ -80,3 +80,10 @@ driver.switch_to.context(context_name)
 This allows elements in iOS applications to be found using recursive element
 search using the UIAutomation library. Adds the methods `driver.find_element_by_ios_uiautomation`
 and `driver.find_elements_by_ios_uiautomation`.
+
+
+### Finding elements by Android UIAutomator search
+
+This allows elements in an Android application to be found using recursive element
+search using the UIAutomator library. Adds the methods `driver.find_element_by_android_uiautomator`
+and `driver.find_elements_by_android_uiautomator`.
diff --git a/appium/webdriver/common/__init__.py b/appium/webdriver/common/__init__.py
@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+
+# 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.
diff --git a/appium/webdriver/common/mobileby.py b/appium/webdriver/common/mobileby.py
@@ -16,3 +16,4 @@
 
 class MobileBy(By):
     IOS_UIAUTOMATION = '-ios uiautomation'
+    ANDROID_UIAUTOMATOR = '-android uiautomator'
diff --git a/appium/webdriver/webdriver.py b/appium/webdriver/webdriver.py
@@ -35,6 +35,7 @@ def __init__(self, command_executor='http://127.0.0.1:4444/wd/hub',
 
         # add new method to the `find_by_*` pantheon
         By.IOS_UIAUTOMATION = MobileBy.IOS_UIAUTOMATION
+        By.ANDROID_UIAUTOMATOR = MobileBy.ANDROID_UIAUTOMATOR
 
     @property
     def contexts(self):
@@ -78,6 +79,28 @@ def find_elements_by_ios_uiautomation(self, uia_string):
         """
         return self.find_elements(by=By.IOS_UIAUTOMATION, value=uia_string)
 
+    def find_element_by_android_uiautomator(self, uia_string):
+        """Finds element by uiautomator in Android.
+
+        :Args:
+         - uia_string - The element name in the Android UIAutomator library
+
+        :Usage:
+            driver.find_element_by_android_uiautomator('.elements()[1].cells()[2]')
+        """
+        return self.find_element(by=By.ANDROID_UIAUTOMATOR, value=uia_string)
+
+    def find_elements_by_android_uiautomator(self, uia_string):
+        """Finds elements by uiautomator in Android.
+
+        :Args:
+         - uia_string - The element name in the Android UIAutomator library
+
+        :Usage:
+            driver.find_elements_by_android_uiautomator('.elements()[1].cells()[2]')
+        """
+        return self.find_elements(by=By.ANDROID_UIAUTOMATOR, value=uia_string)
+
     def _addCommands(self):
         self.command_executor._commands[Command.CONTEXTS] = \
             ('GET', '/session/$sessionId/contexts')
diff --git a/setup.py b/setup.py
@@ -20,6 +20,9 @@
       author='Isaac Murchie',
       author_email='isaac@saucelabs.com',
       url='http://appium.io/',
-      packages=['appium', 'appium.webdriver', 'appium.common'],
+      packages=['appium',
+                'appium.common',
+                'appium.webdriver',
+                'appium.webdriver.common'],
       license='Apache 2.0'
      )
diff --git a/test/apps/ApiDemos-debug.apk b/test/apps/ApiDemos-debug.apk
diff --git a/test/functional/android/find_by_uiautomator_tests.py b/test/functional/android/find_by_uiautomator_tests.py
@@ -0,0 +1,52 @@
+#!/usr/bin/env python
+
+# 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 os
+from time import sleep
+
+from appium import webdriver
+from appium.common.exceptions import NoSuchContextException
+
+import unittest
+
+# Returns abs path relative to this file and not cwd
+PATH = lambda p: os.path.abspath(
+    os.path.join(os.path.dirname(__file__), p)
+)
+
+class FindByUIAutomatorTests(unittest.TestCase):
+    def setUp(self):
+        desired_caps = {}
+        desired_caps['device'] = 'Android'
+        desired_caps['browserName'] = ''
+        desired_caps['version'] = '4.2'
+        desired_caps['app'] = PATH('../../apps/ApiDemos-debug.apk')
+        desired_caps['app-package'] = 'com.example.android.apis'
+        desired_caps['app-activity'] = '.ApiDemos'
+
+        self.driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps)
+
+    def tearDown(self):
+        self.driver.quit()
+
+    def test_find_single_element(self):
+        el = self.driver.find_element_by_android_uiautomator('new UiSelector().description("Animation")')
+        self.assertIsNotNone(el)
+
+    def test_find_multiple_elements(self):
+        els = self.driver.find_elements_by_android_uiautomator('new UiSelector().clickable(true)')
+        self.assertTrue(len(els) > 11)
+
+if __name__ == "__main__":
+    unittest.main()
diff --git a/test/functional/ios/find_by_uiautomation_tests.py b/test/functional/ios/find_by_uiautomation_tests.py
@@ -36,7 +36,7 @@ def test_find_single_element(self):
         el = self.driver.find_element_by_ios_uiautomation('.elements()[0]')
         self.assertEqual('UICatalog', el.get_attribute('name'))
 
-    def test_find_multiple_element(self):
+    def test_find_multiple_elements(self):
         els = self.driver.find_elements_by_ios_uiautomation('elements()')
         self.assertEqual(3, len(els))
 

Original file line number	Diff line number	Diff line change
`@@ -16,3 +16,4 @@`
`16`	`16`
`17`	`17`	`class MobileBy(By):`
`18`	`18`	`IOS_UIAUTOMATION = '-ios uiautomation'`
	`19`	`+ ANDROID_UIAUTOMATOR = '-android uiautomator'`