Rev 2664: Review feedback. in http://people.ubuntu.com/~robertc/baz2.0/pack

[Robert Collins]

At http://people.ubuntu.com/~robertc/baz2.0/pack

------------------------------------------------------------
revno: 2664
revision-id: robertc at robertcollins.net-20070802053516-32sp0lvric0x5ugl
parent: robertc at robertcollins.net-20070802031746-mpnoaxym829719w6
committer: Robert Collins <robertc at robertcollins.net>
branch nick: pack
timestamp: Thu 2007-08-02 15:35:16 +1000
message:
  Review feedback.
modified:
  bzrlib/tests/test_pack.py      test_container.py-20070607160755-tr8zc26q18rn0jnb-2
=== modified file 'bzrlib/tests/test_pack.py'
--- a/bzrlib/tests/test_pack.py	2007-08-02 03:17:46 +0000
+++ b/bzrlib/tests/test_pack.py	2007-08-02 05:35:16 +0000
@@ -391,7 +391,7 @@
         self.assertEqual('', get_bytes(99))
 
 
-class TestReadvReader(tests.TestCaseWithTransport):
+class TestMakeReadvReader(tests.TestCaseWithTransport):
 
     def test_read_skipping_records(self):
         pack_data = StringIO()
@@ -404,8 +404,7 @@
         memos.append(writer.add_bytes_record('jkl', names=[]))
         writer.end()
         transport = self.get_transport()
-        pack_data.seek(0)
-        transport.put_file('mypack', pack_data)
+        transport.put_bytes('mypack', pack_data.getvalue())
         requested_records = [memos[0], memos[2]]
         reader = pack.make_readv_reader(transport, 'mypack', requested_records)
         result = []
@@ -415,9 +414,15 @@
 
 
 class TestReadvFile(tests.TestCaseWithTransport):
+    """Tests of the ReadVFile class.
+
+    Error cases are deliberately undefined: this code adapts the underlying
+    transport interface to a single 'streaming read' interface as 
+    ContainerReader needs.
+    """
 
     def test_read_bytes(self):
-        # this tests byte reading - solo, all in a hunk at once
+        """Test reading of both single bytes and all bytes in a hunk."""
         transport = self.get_transport()
         transport.put_bytes('sample', '0123456789')
         f = pack.ReadVFile(transport.readv('sample', [(0,1), (1,2), (4,1), (6,2)]))
@@ -430,8 +435,10 @@
         self.assertEqual(['0', '12', '4', '6', '7'], results)
 
     def test_readline(self):
-        # this tests readline as the ContainerReader needs it - 
-        # just within a record, never across.
+        """Test using readline() as ContainerReader does.
+
+        This is always within a readv hunk, never across it.
+        """
         transport = self.get_transport()
         transport.put_bytes('sample', '0\n2\n4\n')
         f = pack.ReadVFile(transport.readv('sample', [(0,2), (2,4)]))
@@ -442,7 +449,7 @@
         self.assertEqual(['0\n', '2\n', '4\n'], results)
 
     def test_readline_and_read(self):
-        # this tests read, then readline, then read again 
+        """Test exercising one byte reads, readline, and then read again."""
         transport = self.get_transport()
         transport.put_bytes('sample', '0\n2\n4\n')
         f = pack.ReadVFile(transport.readv('sample', [(0,6)]))