Merge lp:~facundo/ubuntuone-storage-protocol/use-tuneable-maxsize into lp:ubuntuone-storage-protocol

[Facundo Batista]

Change the way the producer decides how much BYTES to send (LP: #767466).

Change the way the producer decides how much BYTES to send.

This way, not being more a constant, StorageClient or any Request can change it easily.

Tests included.

[Lucio Torre (lucio.torre)]

+1

review: Approve

[Guillermo Gonzalez (verterok)]

+1

review: Approve

=== modified file 'tests/test_bytesproducer.py'
--- tests/test_bytesproducer.py	2011-02-22 15:04:43 +0000
+++ tests/test_bytesproducer.py	2011-04-20 18:53:23 +0000
@@ -26,10 +26,7 @@
 from twisted.internet import task
 from twisted.trial.unittest import TestCase as TwistedTestCase
 
-from ubuntuone.storageprotocol import client, request, protocol_pb2
-
-# puts a lower limit, easier for testing
-request.MAX_PAYLOAD_SIZE = 3
+from ubuntuone.storageprotocol import client, protocol_pb2
 
 
 class FakeRequest(object):
@@ -38,6 +35,7 @@
     def __init__(self):
         self.messages = []
         self.cancelled = False
+        self.max_payload_size = 3  # lower limit, easier for testing
 
     def sendMessage(self, message):
         """Store the message in own list."""

=== modified file 'tests/test_client.py'
--- tests/test_client.py	2010-11-05 14:54:42 +0000
+++ tests/test_client.py	2011-04-20 18:53:23 +0000
@@ -17,15 +17,19 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """Tests for the protocol client."""
 
+import StringIO
+import os
 import unittest
 import uuid
 
 from twisted.internet.defer import Deferred
+from twisted.trial.unittest import TestCase as TwistedTestCase
 
 from ubuntuone.storageprotocol import protocol_pb2, sharersp, delta, request
 from ubuntuone.storageprotocol.client import (
-    StorageClient, CreateUDF, ListVolumes, DeleteVolume, GetDelta,
-    Authenticate, MakeFile, MakeDir, PutContent, Move, Unlink)
+    StorageClient, CreateUDF, ListVolumes, DeleteVolume, GetDelta, Unlink,
+    Authenticate, MakeFile, MakeDir, PutContent, Move, BytesMessageProducer,
+)
 from ubuntuone.storageprotocol import volumes
 from tests import test_delta_info
 
@@ -168,6 +172,11 @@
         """Clean up."""
         self.client = None
 
+    def test_init_maxpayloadsize(self):
+        """Get the value from the constant at init time."""
+        self.assertEqual(self.client.max_payload_size,
+                         request.MAX_PAYLOAD_SIZE)
+
     # client to server
     def test_client_get_delta(self):
         """Get a delta."""
@@ -805,5 +814,44 @@
         return Move(FakedProtocol(), None, None, None, None)
 
 
+class PutContentTestCase(TwistedTestCase):
+    """Test cases for PutContent op."""
+
+    def test_max_payload_size(self):
+        """Get the value from the protocol."""
+        self.protocol = FakedProtocol()
+        assert 12345 != self.protocol.max_payload_size
+        self.protocol.max_payload_size = 12345
+        pc = PutContent(self.protocol, None, None, None, None,
+                        None, None, None, None)
+        self.assertEqual(pc.max_payload_size, 12345)
+
+    def test_bytesmessageproducer_maxpayloadsize(self):
+        """The producer uses the payload size from the request."""
+        # set up the PutContent
+        pc = PutContent(FakedProtocol(), None, None, None, None,
+                        None, None, None, None)
+        assert 12345 != pc.max_payload_size
+        pc.max_payload_size = 12345
+
+        # set up the producer
+        fake_file = StringIO.StringIO(os.urandom(100000))
+        producer = BytesMessageProducer(pc, fake_file, 0)
+        producer.producing = True
+
+        # set up a function to check and go!
+        d = Deferred()
+
+        def check(message):
+            """Check."""
+            self.assertEqual(len(message.bytes.bytes), 12345)
+            producer.producing = False
+            d.callback(True)
+
+        pc.sendMessage = check
+        producer.go()
+        return d
+
+
 if __name__ == '__main__':
     unittest.main()

=== modified file 'tests/test_putcontent.py'
--- tests/test_putcontent.py	2011-02-10 19:06:13 +0000
+++ tests/test_putcontent.py	2011-04-20 18:53:23 +0000
@@ -25,8 +25,7 @@
 
 from twisted.test.proto_helpers import StringTransport
 
-from ubuntuone.storageprotocol.request import RequestHandler
-from ubuntuone.storageprotocol.client import PutContent
+from ubuntuone.storageprotocol.client import PutContent, StorageClient
 from ubuntuone.storageprotocol import protocol_pb2
 from mocker import Mocker, ANY
 
@@ -52,7 +51,7 @@
         mocker.result('')
         mocker.replay()
 
-        protocol = RequestHandler()
+        protocol = StorageClient()
         protocol.transport = transport
         pc = PutContent(protocol, 'share', 'node', '', '', 0, 0, 0, fd)
         message = protocol_pb2.Message()
@@ -77,7 +76,7 @@
         mocker.result('')
         mocker.replay()
 
-        protocol = RequestHandler()
+        protocol = StorageClient()
         protocol.transport = transport
         pc = PutContent(protocol, 'share', 'node', '', '', 0, 0, 0, fd)
         message = protocol_pb2.Message()
@@ -92,7 +91,7 @@
     def setUp(self):
         unittest.TestCase.setUp(self)
         transport = StringTransport()
-        self.protocol = RequestHandler()
+        self.protocol = StorageClient()
         self.protocol.transport = transport
 
     def test_server_upload_id(self):

=== modified file 'ubuntuone/storageprotocol/client.py'
--- ubuntuone/storageprotocol/client.py	2011-02-23 19:48:51 +0000
+++ ubuntuone/storageprotocol/client.py	2011-04-20 18:53:23 +0000
@@ -60,6 +60,7 @@
         self._volume_new_generation_callback = None
 
         self.line_mode = True
+        self.max_payload_size = request.MAX_PAYLOAD_SIZE
 
     def protocol_version(self):
         """Ask for the protocol version
@@ -1119,7 +1120,7 @@
 
         if self.offset:
             self.fh.seek(self.offset)
-        data = self.fh.read(request.MAX_PAYLOAD_SIZE)
+        data = self.fh.read(self.request.max_payload_size)
         if data:
             if self.offset:
                 self.offset += len(data)
@@ -1174,6 +1175,7 @@
         self.upload_id = upload_id
         self.new_generation = None
         self.magic_hash = magic_hash
+        self.max_payload_size = protocol.max_payload_size
 
     def _start(self):
         """Send PUT_CONTENT."""