# Copyright (C) 2007 Canonical Ltd # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """Tests for bzrlib.pack.""" from cStringIO import StringIO from bzrlib import pack, errors, tests class TestContainerWriter(tests.TestCase): def test_construct(self): """Test constructing a ContainerWriter. This uses None as the output stream to show that the constructor doesn't try to use the output stream. """ writer = pack.ContainerWriter(None) def test_begin(self): """The begin() method writes the container format marker line.""" output = StringIO() writer = pack.ContainerWriter(output.write) writer.begin() self.assertEqual('Bazaar pack format 1\n', output.getvalue()) def test_end(self): """The end() method writes an End Marker record.""" output = StringIO() writer = pack.ContainerWriter(output.write) writer.begin() writer.end() self.assertEqual('Bazaar pack format 1\nE', output.getvalue()) def test_add_bytes_record_no_name(self): """Add a bytes record with no name.""" output = StringIO() writer = pack.ContainerWriter(output.write) writer.begin() writer.add_bytes_record('abc', names=[]) self.assertEqual('Bazaar pack format 1\nB3\n\nabc', output.getvalue()) def test_add_bytes_record_one_name(self): """Add a bytes record with one name.""" output = StringIO() writer = pack.ContainerWriter(output.write) writer.begin() writer.add_bytes_record('abc', names=['name1']) self.assertEqual('Bazaar pack format 1\nB3\nname1\n\nabc', output.getvalue()) def test_add_bytes_record_two_names(self): """Add a bytes record with two names.""" output = StringIO() writer = pack.ContainerWriter(output.write) writer.begin() writer.add_bytes_record('abc', names=['name1', 'name2']) self.assertEqual('Bazaar pack format 1\nB3\nname1\nname2\n\nabc', output.getvalue()) def test_add_bytes_record_invalid_name(self): """Adding a Bytes record with a name with whitespace in it raises InvalidRecordError. """ output = StringIO() writer = pack.ContainerWriter(output.write) writer.begin() self.assertRaises( errors.InvalidRecordError, writer.add_bytes_record, 'abc', names=['bad name']) class TestContainerReader(tests.TestCase): def test_construct(self): """Test constructing a ContainerReader. This uses None as the output stream to show that the constructor doesn't try to use the input stream. """ reader = pack.ContainerReader(None) def test_empty_container(self): """Read an empty container.""" input = StringIO("Bazaar pack format 1\nE") reader = pack.ContainerReader(input.read) self.assertEqual([], list(reader.iter_records())) def test_unknown_format(self): """Unrecognised container formats raise UnknownContainerFormatError.""" input = StringIO("unknown format\n") reader = pack.ContainerReader(input.read) self.assertRaises( errors.UnknownContainerFormatError, reader.iter_records) def test_unexpected_end_of_container(self): """Containers that don't end with an End Marker record should cause UnexpectedEndOfContainerError to be raised. """ input = StringIO("Bazaar pack format 1\n") reader = pack.ContainerReader(input.read) iterator = reader.iter_records() self.assertRaises( errors.UnexpectedEndOfContainerError, iterator.next) def test_unknown_record_type(self): """Unknown record types cause UnknownRecordTypeError to be raised.""" input = StringIO("Bazaar pack format 1\nX") reader = pack.ContainerReader(input.read) iterator = reader.iter_records() self.assertRaises( errors.UnknownRecordTypeError, iterator.next) def test_container_with_one_unnamed_record(self): """Read a container with one Bytes record. Parsing Bytes records is more thoroughly exercised by TestBytesRecordReader. This test is here to ensure that ContainerReader's integration with BytesRecordReader is working. """ input = StringIO("Bazaar pack format 1\nB5\n\naaaaaE") reader = pack.ContainerReader(input.read) expected_records = [([], 'aaaaa')] self.assertEqual(expected_records, list(reader.iter_records())) class TestBytesRecordReader(tests.TestCase): """Tests for parsing Bytes records with BytesRecordReader.""" def test_record_with_no_name(self): """Reading a Bytes record with no name returns an empty list of names. """ input = StringIO("5\n\naaaaa") reader = pack.BytesRecordReader(input.read) names, bytes = reader.read() self.assertEqual([], names) self.assertEqual('aaaaa', bytes) def test_record_with_one_name(self): """Reading a Bytes record with one name returns a list of just that name. """ input = StringIO("5\nname1\n\naaaaa") reader = pack.BytesRecordReader(input.read) names, bytes = reader.read() self.assertEqual(['name1'], names) self.assertEqual('aaaaa', bytes) def test_record_with_two_names(self): """Reading a Bytes record with two names returns a list of both names. """ input = StringIO("5\nname1\nname2\n\naaaaa") reader = pack.BytesRecordReader(input.read) names, bytes = reader.read() self.assertEqual(['name1', 'name2'], names) self.assertEqual('aaaaa', bytes) def test_invalid_length(self): """If the length-prefix is not a number, parsing raises InvalidRecordError. """ input = StringIO("not a number\n") reader = pack.BytesRecordReader(input.read) self.assertRaises(errors.InvalidRecordError, reader.read) def test_early_eof(self): """Tests for premature EOF occuring during parsing Bytes records with BytesRecordReader. A incomplete container might be interrupted at any point. The BytesRecordReader needs to cope with the input stream running out no matter where it is in the parsing process. In all cases, UnexpectedEndOfContainerError should be raised. """ complete_record = "6\nname\n\nabcdef" for count in range(0, len(complete_record)): input = StringIO(complete_record[:count]) reader = pack.BytesRecordReader(input.read) # We don't use assertRaises to make diagnosing failures easier. try: reader.read() except errors.UnexpectedEndOfContainerError: pass else: self.fail( "UnexpectedEndOfContainerError not raised when parsing %r" % (input.getvalue())) def test_initial_eof(self): """EOF before any bytes read at all.""" input = StringIO("") reader = pack.BytesRecordReader(input.read) self.assertRaises(errors.UnexpectedEndOfContainerError, reader.read) def test_eof_after_length(self): """EOF after reading the length and before reading name(s).""" input = StringIO("123\n") reader = pack.BytesRecordReader(input.read) self.assertRaises(errors.UnexpectedEndOfContainerError, reader.read) def test_eof_during_name(self): """EOF during reading a name.""" input = StringIO("123\nname") reader = pack.BytesRecordReader(input.read) self.assertRaises(errors.UnexpectedEndOfContainerError, reader.read) def test_invalid_name_whitespace(self): """Names must have no whitespace.""" # A name with a space. input = StringIO("0\nbad name\n\n") reader = pack.BytesRecordReader(input.read) self.assertRaises(errors.InvalidRecordError, reader.read) # A name with a tab. input = StringIO("0\nbad\tname\n\n") reader = pack.BytesRecordReader(input.read) self.assertRaises(errors.InvalidRecordError, reader.read) # A name with a vertical tab. input = StringIO("0\nbad\vname\n\n") reader = pack.BytesRecordReader(input.read) self.assertRaises(errors.InvalidRecordError, reader.read)