Merge pull request appium#28 from appium/isaac-pullfile

jlipps · jlipps · commit cdbb692212be · 2014-06-16T15:23:01.000-07:00
Add pull_file method
diff --git a/appium/webdriver/mobilecommand.py b/appium/webdriver/mobilecommand.py
@@ -30,6 +30,7 @@ class MobileCommand(object):
     GET_CURRENT_ACTIVITY = 'getCurrentActivity'
     SET_IMMEDIATE_VALUE = 'setImmediateValue'
     PULL_FILE = 'pullFile'
+    PULL_FOLDER = 'pullFolder'
     PUSH_FILE = 'pushFile'
     COMPLEX_FIND = 'complexFind'
     BACKGROUND = 'background'
diff --git a/appium/webdriver/webdriver.py b/appium/webdriver/webdriver.py
@@ -421,6 +421,18 @@ def pull_file(self, path):
         }
         return self.execute(Command.PULL_FILE, data)['value']
 
+    def pull_folder(self, path):
+        """Retrieves a folder at `path`. Returns the folder's contents zipped
+        and encoded as Base64.
+
+        :Args:
+         - path - the path to the folder on the device
+        """
+        data = {
+            'path': path,
+        }
+        return self.execute(Command.PULL_FOLDER, data)['value']
+
     def push_file(self, path, base64data):
         """Puts the data, encoded as Base64, in the file specified as `path`.
 
@@ -574,6 +586,8 @@ def _addCommands(self):
             ('POST', '/session/$sessionId/appium/element/$elementId/value')
         self.command_executor._commands[Command.PULL_FILE] = \
             ('POST', '/session/$sessionId/appium/device/pull_file')
+        self.command_executor._commands[Command.PULL_FOLDER] = \
+            ('POST', '/session/$sessionId/appium/device/pull_folder')
         self.command_executor._commands[Command.PUSH_FILE] = \
             ('POST', '/session/$sessionId/appium/device/push_file')
         self.command_executor._commands[Command.COMPLEX_FIND] = \
diff --git a/setup.py b/setup.py
@@ -17,7 +17,7 @@
 
 setup(
     name='Appium-Python-Client',
-    version='0.6',
+    version='0.7',
     description='Python client for Appium 1.0',
     keywords=[
         'appium',
diff --git a/test/functional/android/appium_tests.py b/test/functional/android/appium_tests.py
@@ -14,7 +14,10 @@
 # limitations under the License.
 
 import unittest
+from zipfile import ZipFile
 import json
+import os
+import random
 from time import sleep
 
 from selenium.common.exceptions import NoSuchElementException
@@ -35,6 +38,10 @@ def setUp(self):
     def tearDown(self):
         self.driver.quit()
 
+        # remove zipped file from `test_pull_folder`
+        if os.path.isfile(self.zipfilename):
+            os.remove(self.zipfilename)
+
     def test_app_strings(self):
         strings = self.driver.app_strings()
         self.assertEqual(u'You can\'t wipe my data, you are a monkey!', strings[u'monkey_wipe_data'])
@@ -67,6 +74,25 @@ def test_push_file(self):
         data_ret = self.driver.pull_file('data/local/tmp/test_push_file.txt').decode('base64')
         self.assertEqual(data, data_ret)
 
+    def test_pull_folder(self):
+        string_data = 'random string data %d' % random.randint(0, 1000)
+        path = '/data/local/tmp'
+        self.driver.push_file(path + '/1.txt', string_data.encode('base64'))
+        self.driver.push_file(path + '/2.txt', string_data.encode('base64'))
+        folder = self.driver.pull_folder(path)
+
+        # python doesn't have any functionality for unzipping streams
+        # save temporary file, which will be deleted in `tearDown`
+        self.zipfilename = 'folder_%d.zip' % random.randint(0, 1000000)
+        file = open(self.zipfilename, "w")
+        file.write(folder.decode('base64', 'strict'))
+        file.close()
+
+        with ZipFile(self.zipfilename, 'r') as myzip:
+            # should find these. otherwise it will raise a `KeyError`
+            myzip.read('1.txt')
+            myzip.read('2.txt')
+
     def test_complex_find(self):
         # this only works with a three dimensional array like here.
         el = self.driver.complex_find([[[2, 'Ani']]])
