Add interfaces for client-side string upload

Issues:
Fixes #454

Problem: We need to upload secrets without writing them to a file
on the client side.

Tests: unittests in test_file_uploads.py

Author: zancas

f5/bigip/cm/autodeploy/software_images.py

@@ -38,7 +38,7 @@ def upload_image(self, filepathname, **kwargs):
         if os.path.splitext(filename)[-1] != '.iso':
             raise ImageFilesMustHaveDotISOExtension(filename)
         self.file_bound_uri = self._meta_data['uri'] + filename
-        self._upload(filepathname, **kwargs)
+        self._upload_file(filepathname, **kwargs)
 #
 #
 # class Software_Image_Downloads(PathElement):

f5/bigip/mixins.py

@@ -17,7 +17,6 @@
 # NOTE:  Code taken from Effective Python Item 26
 
 import logging
-import os
 
 from f5.sdk_exception import F5SDKError
 
@@ -243,34 +242,40 @@ def _exec_cmd(self, command, **kwargs):
 
 
 class FileUploadMixin(object):
-    def _upload(self, filepathname, **kwargs):
+    def _upload_file(self, filepathname, **kwargs):
+        with open(filepathname, 'rb') as fileobj:
+            self._upload(fileobj, **kwargs)
+
+    def _upload(self, fileinterface, **kwargs):
+        size = len(fileinterface.read())
+        fileinterface.seek(0)
         requests_params = self._handle_requests_params(kwargs)
         session = self._meta_data['icr_session']
         chunk_size = kwargs.pop('chunk_size', 512 * 1024)
-        size = os.path.getsize(filepathname)
         start = 0
-        with open(filepathname, 'rb') as fileobj:
-            while True:
-                file_slice = fileobj.read(chunk_size)
-                if not file_slice:
-                    break
-
-                current_bytes = len(file_slice)
-                if current_bytes < chunk_size:
-                    end = size
-                else:
-                    end = start + current_bytes
-                headers = {
-                    'Content-Range': '%s-%s/%s' % (start, end - 1, size),
-                    'Content-Type': 'application/octet-stream'}
-                data = {'data': file_slice,
-                        'headers': headers,
-                        'verify': False}
-                logging.debug(data)
-                requests_params.update(data)
-                session.post(self.file_bound_uri,
-                             **requests_params)
-                start += current_bytes
+        while True:
+            file_slice = fileinterface.read(chunk_size)
+            if not file_slice:
+                break
+
+            current_bytes = len(file_slice)
+            if current_bytes < chunk_size:
+                end = size
+            else:
+                end = start + current_bytes
+            headers = {
+                'Content-Range': '%s-%s/%s' % (start,
+                                               end - 1,
+                                               size),
+                'Content-Type': 'application/octet-stream'}
+            data = {'data': file_slice,
+                    'headers': headers,
+                    'verify': False}
+            logging.debug(data)
+            requests_params.update(data)
+            session.post(self.file_bound_uri,
+                         **requests_params)
+            start += current_bytes
 
 
 class DeviceMixin(object):

f5/bigip/shared/file_transfer.py

@@ -17,6 +17,7 @@
 #
 
 import os
+from StringIO import StringIO
 
 from f5.bigip.mixins import FileUploadMixin
 from f5.bigip.resource import PathElement
@@ -47,4 +48,12 @@ def upload_file(self, filepathname, **kwargs):
         if os.path.splitext(filename)[-1] == '.iso':
             raise FileMustNotHaveDotISOExtension(filename)
         self.file_bound_uri = self._meta_data['uri'] + filename
-        self._upload(filepathname, **kwargs)
+        self._upload_file(filepathname, **kwargs)
+
+    def upload_stringio(self, stringio, target, **kwargs):
+        self.file_bound_uri = self._meta_data['uri'] + target
+        self._upload(stringio, **kwargs)
+
+    def upload_bytes(self, bytestring, target, **kwargs):
+        self.file_bound_uri = self._meta_data['uri'] + target
+        self._upload(StringIO(bytestring), **kwargs)

f5/bigip/shared/test/test_file_uploads.py

@@ -14,8 +14,8 @@
 #
 
 import mock
-
 import pytest
+from StringIO import StringIO
 
 from f5.bigip import ManagementRoot
 from f5.bigip.shared.file_transfer import\
@@ -59,3 +59,55 @@ def test_ISO_extension(tmpdir):
     with pytest.raises(FileMustNotHaveDotISOExtension) as EIO:
         ftu.upload_file(filepath.__str__(), chunk_size=21)
     assert EIO.value.message == 'wrongname.iso'
+
+
+def test_stringio_upload_80a(tmpdir):
+    sio = StringIO(80*'a')
+    mr = ManagementRoot('FAKENETLOC', 'FAKENAME', 'FAKEPASSWORD')
+    mr._meta_data['icr_session'] = mock.MagicMock()
+    ftu = mr.shared.file_transfer.uploads
+    ftu.upload_stringio(sio, 'testtarget', chunk_size=20)
+    session_mock = mr._meta_data['icr_session']
+    for i in range(4):
+        d = session_mock.post.call_args_list[i][1]['data']
+        assert d == 'aaaaaaaaaaaaaaaaaaaa'
+
+
+def test_stringio_upload_70a(tmpdir):
+    sio = StringIO(70*'a')
+    mr = ManagementRoot('FAKENETLOC', 'FAKENAME', 'FAKEPASSWORD')
+    mr._meta_data['icr_session'] = mock.MagicMock()
+    ftu = mr.shared.file_transfer.uploads
+    ftu.upload_stringio(sio, 'testtarget', chunk_size=20)
+    session_mock = mr._meta_data['icr_session']
+    for i in range(3):
+        d = session_mock.post.call_args_list[i][1]['data']
+        assert d == 'aaaaaaaaaaaaaaaaaaaa'
+    lchunk = session_mock.post.call_args_list[3][1]['data']
+    assert 10*'a' == lchunk
+
+
+def test_bytes_upload_80a(tmpdir):
+    bytestring80a = 80*'a'
+    mr = ManagementRoot('FAKENETLOC', 'FAKENAME', 'FAKEPASSWORD')
+    mr._meta_data['icr_session'] = mock.MagicMock()
+    ftu = mr.shared.file_transfer.uploads
+    ftu.upload_bytes(bytestring80a, 'testtarget', chunk_size=20)
+    session_mock = mr._meta_data['icr_session']
+    for i in range(4):
+        d = session_mock.post.call_args_list[i][1]['data']
+        assert d == 'aaaaaaaaaaaaaaaaaaaa'
+
+
+def test_bytes_upload_70a(tmpdir):
+    bytestring70a = 70*'a'
+    mr = ManagementRoot('FAKENETLOC', 'FAKENAME', 'FAKEPASSWORD')
+    mr._meta_data['icr_session'] = mock.MagicMock()
+    ftu = mr.shared.file_transfer.uploads
+    ftu.upload_bytes(bytestring70a, 'testtarget', chunk_size=20)
+    session_mock = mr._meta_data['icr_session']
+    for i in range(3):
+        d = session_mock.post.call_args_list[i][1]['data']
+        assert d == 'aaaaaaaaaaaaaaaaaaaa'
+    lchunk = session_mock.post.call_args_list[3][1]['data']
+    assert 10*'a' == lchunk