1
# Copyright (C) 2005, 2006, 2007, 2009, 2010, 2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tests for rio serialization
19
A simple, reproducible structured IO format.
21
rio itself works in Unicode strings. It is typically encoded to UTF-8,
22
but this depends on the transport.
26
from tempfile import TemporaryFile
31
from bzrlib.tests import TestCase
32
from bzrlib.rio import (
41
class TestRio(TestCase):
43
def test_stanza(self):
44
"""Construct rio stanza in memory"""
45
s = Stanza(number='42', name="fred")
46
self.assertTrue('number' in s)
47
self.assertFalse('color' in s)
48
self.assertFalse('42' in s)
49
self.assertEquals(list(s.iter_pairs()),
50
[('name', 'fred'), ('number', '42')])
51
self.assertEquals(s.get('number'), '42')
52
self.assertEquals(s.get('name'), 'fred')
54
def test_value_checks(self):
55
"""rio checks types on construction"""
56
# these aren't enforced at construction time
57
## self.assertRaises(ValueError,
58
## Stanza, complex=42 + 3j)
59
## self.assertRaises(ValueError,
60
## Stanza, several=range(10))
62
def test_empty_value(self):
63
"""Serialize stanza with empty field"""
65
self.assertEqualDiff(s.to_string(),
68
def test_to_lines(self):
69
"""Write simple rio stanza to string"""
70
s = Stanza(number='42', name='fred')
71
self.assertEquals(list(s.to_lines()),
75
def test_as_dict(self):
76
"""Convert rio Stanza to dictionary"""
77
s = Stanza(number='42', name='fred')
79
self.assertEquals(sd, dict(number='42', name='fred'))
81
def test_to_file(self):
82
"""Write rio to file"""
83
tmpf = TemporaryFile()
84
s = Stanza(a_thing='something with "quotes like \\"this\\""', number='42', name='fred')
87
self.assertEqualDiff(tmpf.read(), r'''
88
a_thing: something with "quotes like \"this\""
93
def test_multiline_string(self):
94
tmpf = TemporaryFile()
95
s = Stanza(motto="war is peace\nfreedom is slavery\nignorance is strength")
98
self.assertEqualDiff(tmpf.read(), '''\
101
\tignorance is strength
104
s2 = read_stanza(tmpf)
105
self.assertEquals(s, s2)
107
def test_read_stanza(self):
108
"""Load stanza from string"""
110
revision: mbp@sourcefrog.net-123-abc
111
timestamp: 1130653962
113
committer: Martin Pool <mbp@test.sourcefrog.net>
115
s = read_stanza(lines)
116
self.assertTrue('revision' in s)
117
self.assertEqualDiff(s.get('revision'), 'mbp@sourcefrog.net-123-abc')
118
self.assertEquals(list(s.iter_pairs()),
119
[('revision', 'mbp@sourcefrog.net-123-abc'),
120
('timestamp', '1130653962'),
121
('timezone', '36000'),
122
('committer', "Martin Pool <mbp@test.sourcefrog.net>")])
123
self.assertEquals(len(s), 4)
125
def test_repeated_field(self):
126
"""Repeated field in rio"""
128
for k, v in [('a', '10'), ('b', '20'), ('a', '100'), ('b', '200'),
129
('a', '1000'), ('b', '2000')]:
131
s2 = read_stanza(s.to_lines())
132
self.assertEquals(s, s2)
133
self.assertEquals(s.get_all('a'), map(str, [10, 100, 1000]))
134
self.assertEquals(s.get_all('b'), map(str, [20, 200, 2000]))
136
def test_backslash(self):
139
self.assertEqualDiff(t, 'q: \\\n')
140
s2 = read_stanza(s.to_lines())
141
self.assertEquals(s, s2)
143
def test_blank_line(self):
144
s = Stanza(none='', one='\n', two='\n\n')
145
self.assertEqualDiff(s.to_string(), """\
153
s2 = read_stanza(s.to_lines())
154
self.assertEquals(s, s2)
156
def test_whitespace_value(self):
157
s = Stanza(space=' ', tabs='\t\t\t', combo='\n\t\t\n')
158
self.assertEqualDiff(s.to_string(), """\
165
s2 = read_stanza(s.to_lines())
166
self.assertEquals(s, s2)
167
self.rio_file_stanzas([s])
169
def test_quoted(self):
170
"""rio quoted string cases"""
171
s = Stanza(q1='"hello"',
181
s2 = read_stanza(s.to_lines())
182
self.assertEquals(s, s2)
183
# apparent bug in read_stanza
184
# s3 = read_stanza(self.stanzas_to_str([s]))
185
# self.assertEquals(s, s3)
187
def test_read_empty(self):
188
"""Detect end of rio file"""
190
self.assertEqual(s, None)
191
self.assertTrue(s is None)
193
def test_read_nul_byte(self):
194
"""File consisting of a nul byte causes an error."""
195
self.assertRaises(ValueError, read_stanza, ['\0'])
197
def test_read_nul_bytes(self):
198
"""File consisting of many nul bytes causes an error."""
199
self.assertRaises(ValueError, read_stanza, ['\0' * 100])
201
def test_read_iter(self):
202
"""Read several stanzas from file"""
203
tmpf = TemporaryFile()
214
reader = read_stanzas(tmpf)
215
read_iter = iter(reader)
217
self.assertEqual(stuff,
218
[ Stanza(version_header='1'),
219
Stanza(name="foo", val='123'),
220
Stanza(name="bar", val='129319'), ])
222
def test_read_several(self):
223
"""Read several stanzas from file"""
224
tmpf = TemporaryFile()
232
address: "Willowglen"
240
s = read_stanza(tmpf)
241
self.assertEquals(s, Stanza(version_header='1'))
242
s = read_stanza(tmpf)
243
self.assertEquals(s, Stanza(name="foo", val='123'))
244
s = read_stanza(tmpf)
245
self.assertEqualDiff(s.get('name'), 'quoted')
246
self.assertEqualDiff(s.get('address'), ' "Willowglen"\n 42 Wallaby Way\n Sydney')
247
s = read_stanza(tmpf)
248
self.assertEquals(s, Stanza(name="bar", val='129319'))
249
s = read_stanza(tmpf)
250
self.assertEquals(s, None)
251
self.check_rio_file(tmpf)
253
def check_rio_file(self, real_file):
255
read_write = rio_file(RioReader(real_file)).read()
257
self.assertEquals(read_write, real_file.read())
260
def stanzas_to_str(stanzas):
261
return rio_file(stanzas).read()
263
def rio_file_stanzas(self, stanzas):
264
new_stanzas = list(RioReader(rio_file(stanzas)))
265
self.assertEqual(new_stanzas, stanzas)
267
def test_tricky_quoted(self):
268
tmpf = TemporaryFile()
302
expected_vals = ['"one"',
315
for expected in expected_vals:
316
stanza = read_stanza(tmpf)
317
self.rio_file_stanzas([stanza])
318
self.assertEquals(len(stanza), 1)
319
self.assertEqualDiff(stanza.get('s'), expected)
321
def test_write_empty_stanza(self):
322
"""Write empty stanza"""
323
l = list(Stanza().to_lines())
324
self.assertEquals(l, [])
326
def test_rio_raises_type_error(self):
327
"""TypeError on adding invalid type to Stanza"""
329
self.assertRaises(TypeError, s.add, 'foo', {})
331
def test_rio_raises_type_error_key(self):
332
"""TypeError on adding invalid type to Stanza"""
334
self.assertRaises(TypeError, s.add, 10, {})
336
def test_rio_unicode(self):
337
uni_data = u'\N{KATAKANA LETTER O}'
338
s = Stanza(foo=uni_data)
339
self.assertEquals(s.get('foo'), uni_data)
340
raw_lines = s.to_lines()
341
self.assertEquals(raw_lines,
342
['foo: ' + uni_data.encode('utf-8') + '\n'])
343
new_s = read_stanza(raw_lines)
344
self.assertEquals(new_s.get('foo'), uni_data)
346
def test_rio_to_unicode(self):
347
uni_data = u'\N{KATAKANA LETTER O}'
348
s = Stanza(foo=uni_data)
349
unicode_str = s.to_unicode()
350
self.assertEqual(u'foo: %s\n' % (uni_data,), unicode_str)
351
new_s = rio.read_stanza_unicode(unicode_str.splitlines(True))
352
self.assertEqual(uni_data, new_s.get('foo'))
354
def test_nested_rio_unicode(self):
355
uni_data = u'\N{KATAKANA LETTER O}'
356
s = Stanza(foo=uni_data)
357
parent_stanza = Stanza(child=s.to_unicode())
358
raw_lines = parent_stanza.to_lines()
359
self.assertEqual(['child: foo: ' + uni_data.encode('utf-8') + '\n',
362
new_parent = read_stanza(raw_lines)
363
child_text = new_parent.get('child')
364
self.assertEqual(u'foo: %s\n' % uni_data, child_text)
365
new_child = rio.read_stanza_unicode(child_text.splitlines(True))
366
self.assertEqual(uni_data, new_child.get('foo'))
368
def mail_munge(self, lines, dos_nl=True):
371
line = re.sub(' *\n', '\n', line)
373
line = re.sub('([^\r])\n', '\\1\r\n', line)
374
new_lines.append(line)
377
def test_patch_rio(self):
378
stanza = Stanza(data='#\n\r\\r ', space=' ' * 255, hash='#' * 255)
379
lines = rio.to_patch_lines(stanza)
381
self.assertContainsRe(line, '^# ')
382
self.assertTrue(72 >= len(line))
383
for line in rio.to_patch_lines(stanza, max_width=12):
384
self.assertTrue(12 >= len(line))
385
new_stanza = rio.read_patch_stanza(self.mail_munge(lines,
387
lines = self.mail_munge(lines)
388
new_stanza = rio.read_patch_stanza(lines)
389
self.assertEqual('#\n\r\\r ', new_stanza.get('data'))
390
self.assertEqual(' '* 255, new_stanza.get('space'))
391
self.assertEqual('#'* 255, new_stanza.get('hash'))
393
def test_patch_rio_linebreaks(self):
394
stanza = Stanza(breaktest='linebreak -/'*30)
395
self.assertContainsRe(rio.to_patch_lines(stanza, 71)[0],
397
stanza = Stanza(breaktest='linebreak-/'*30)
398
self.assertContainsRe(rio.to_patch_lines(stanza, 70)[0],
400
stanza = Stanza(breaktest='linebreak/'*30)
401
self.assertContainsRe(rio.to_patch_lines(stanza, 70)[0],
added
removed
bzrlib/tests/test_rio.py
