1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
|
# Copyright (C) 2008, 2009 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Tests for the python and pyrex extensions of groupcompress"""
from bzrlib import (
groupcompress,
_groupcompress_py,
tests,
)
def load_tests(standard_tests, module, loader):
"""Parameterize tests for all versions of groupcompress."""
two_way_scenarios = [
('PP', {'make_delta': _groupcompress_py.make_delta,
'apply_delta': _groupcompress_py.apply_delta})
]
scenarios = [
('python', {'_gc_module': _groupcompress_py}),
]
if CompiledGroupCompressFeature.available():
from bzrlib import _groupcompress_pyx
scenarios.append(('C',
{'_gc_module': _groupcompress_pyx}))
two_way_scenarios.extend([
('CC', {'make_delta': _groupcompress_pyx.make_delta,
'apply_delta': _groupcompress_pyx.apply_delta}),
('PC', {'make_delta': _groupcompress_py.make_delta,
'apply_delta': _groupcompress_pyx.apply_delta}),
('CP', {'make_delta': _groupcompress_pyx.make_delta,
'apply_delta': _groupcompress_py.apply_delta}),
])
to_adapt, result = tests.split_suite_by_condition(
standard_tests, tests.condition_isinstance((TestMakeAndApplyDelta,
TestBase128Int)))
result = tests.multiply_tests(to_adapt, scenarios, result)
to_adapt, result = tests.split_suite_by_condition(result,
tests.condition_isinstance(TestMakeAndApplyCompatible))
result = tests.multiply_tests(to_adapt, two_way_scenarios, result)
return result
class _CompiledGroupCompressFeature(tests.Feature):
def _probe(self):
try:
import bzrlib._groupcompress_pyx
except ImportError:
return False
else:
return True
def feature_name(self):
return 'bzrlib._groupcompress_pyx'
CompiledGroupCompressFeature = _CompiledGroupCompressFeature()
_text1 = """\
This is a bit
of source text
which is meant to be matched
against other text
"""
_text2 = """\
This is a bit
of source text
which is meant to differ from
against other text
"""
_text3 = """\
This is a bit
of source text
which is meant to be matched
against other text
except it also
has a lot more data
at the end of the file
"""
_first_text = """\
a bit of text, that
does not have much in
common with the next text
"""
_second_text = """\
some more bit of text, that
does not have much in
common with the previous text
and has some extra text
"""
_third_text = """\
a bit of text, that
has some in common with the previous text
and has some extra text
and not have much in
common with the next text
"""
_fourth_text = """\
123456789012345
same rabin hash
123456789012345
same rabin hash
123456789012345
same rabin hash
123456789012345
same rabin hash
"""
class TestMakeAndApplyDelta(tests.TestCase):
_gc_module = None # Set by load_tests
def setUp(self):
super(TestMakeAndApplyDelta, self).setUp()
self.make_delta = self._gc_module.make_delta
self.apply_delta = self._gc_module.apply_delta
self.apply_delta_to_source = self._gc_module.apply_delta_to_source
def test_make_delta_is_typesafe(self):
self.make_delta('a string', 'another string')
def _check_make_delta(string1, string2):
self.assertRaises(TypeError, self.make_delta, string1, string2)
_check_make_delta('a string', object())
_check_make_delta('a string', u'not a string')
_check_make_delta(object(), 'a string')
_check_make_delta(u'not a string', 'a string')
def test_make_noop_delta(self):
ident_delta = self.make_delta(_text1, _text1)
self.assertEqual('M\x90M', ident_delta)
ident_delta = self.make_delta(_text2, _text2)
self.assertEqual('N\x90N', ident_delta)
ident_delta = self.make_delta(_text3, _text3)
self.assertEqual('\x87\x01\x90\x87', ident_delta)
def assertDeltaIn(self, delta1, delta2, delta):
"""Make sure that the delta bytes match one of the expectations."""
# In general, the python delta matcher gives different results than the
# pyrex delta matcher. Both should be valid deltas, though.
if delta not in (delta1, delta2):
self.fail("Delta bytes:\n"
" %r\n"
"not in %r\n"
" or %r"
% (delta, delta1, delta2))
def test_make_delta(self):
delta = self.make_delta(_text1, _text2)
self.assertDeltaIn(
'N\x90/\x1fdiffer from\nagainst other text\n',
'N\x90\x1d\x1ewhich is meant to differ from\n\x91:\x13',
delta)
delta = self.make_delta(_text2, _text1)
self.assertDeltaIn(
'M\x90/\x1ebe matched\nagainst other text\n',
'M\x90\x1d\x1dwhich is meant to be matched\n\x91;\x13',
delta)
delta = self.make_delta(_text3, _text1)
self.assertEqual('M\x90M', delta)
delta = self.make_delta(_text3, _text2)
self.assertDeltaIn(
'N\x90/\x1fdiffer from\nagainst other text\n',
'N\x90\x1d\x1ewhich is meant to differ from\n\x91:\x13',
delta)
def test_make_delta_with_large_copies(self):
# We want to have a copy that is larger than 64kB, which forces us to
# issue multiple copy instructions.
big_text = _text3 * 1220
delta = self.make_delta(big_text, big_text)
self.assertDeltaIn(
'\xdc\x86\x0a' # Encoding the length of the uncompressed text
'\x80' # Copy 64kB, starting at byte 0
'\x84\x01' # and another 64kB starting at 64kB
'\xb4\x02\x5c\x83', # And the bit of tail.
None, # Both implementations should be identical
delta)
def test_apply_delta_is_typesafe(self):
self.apply_delta(_text1, 'M\x90M')
self.assertRaises(TypeError, self.apply_delta, object(), 'M\x90M')
self.assertRaises(TypeError, self.apply_delta,
unicode(_text1), 'M\x90M')
self.assertRaises(TypeError, self.apply_delta, _text1, u'M\x90M')
self.assertRaises(TypeError, self.apply_delta, _text1, object())
def test_apply_delta(self):
target = self.apply_delta(_text1,
'N\x90/\x1fdiffer from\nagainst other text\n')
self.assertEqual(_text2, target)
target = self.apply_delta(_text2,
'M\x90/\x1ebe matched\nagainst other text\n')
self.assertEqual(_text1, target)
def test_apply_delta_to_source_is_safe(self):
self.assertRaises(TypeError,
self.apply_delta_to_source, object(), 0, 1)
self.assertRaises(TypeError,
self.apply_delta_to_source, u'unicode str', 0, 1)
# end > length
self.assertRaises(ValueError,
self.apply_delta_to_source, 'foo', 1, 4)
# start > length
self.assertRaises(ValueError,
self.apply_delta_to_source, 'foo', 5, 3)
# start > end
self.assertRaises(ValueError,
self.apply_delta_to_source, 'foo', 3, 2)
def test_apply_delta_to_source(self):
source_and_delta = (_text1
+ 'N\x90/\x1fdiffer from\nagainst other text\n')
self.assertEqual(_text2, self.apply_delta_to_source(source_and_delta,
len(_text1), len(source_and_delta)))
class TestMakeAndApplyCompatible(tests.TestCase):
make_delta = None # Set by load_tests
apply_delta = None # Set by load_tests
def assertMakeAndApply(self, source, target):
"""Assert that generating a delta and applying gives success."""
delta = self.make_delta(source, target)
bytes = self.apply_delta(source, delta)
self.assertEqualDiff(target, bytes)
def test_direct(self):
self.assertMakeAndApply(_text1, _text2)
self.assertMakeAndApply(_text2, _text1)
self.assertMakeAndApply(_text1, _text3)
self.assertMakeAndApply(_text3, _text1)
self.assertMakeAndApply(_text2, _text3)
self.assertMakeAndApply(_text3, _text2)
class TestDeltaIndex(tests.TestCase):
def setUp(self):
super(TestDeltaIndex, self).setUp()
# This test isn't multiplied, because we only have DeltaIndex for the
# compiled form
# We call this here, because _test_needs_features happens after setUp
self.requireFeature(CompiledGroupCompressFeature)
from bzrlib import _groupcompress_pyx
self._gc_module = _groupcompress_pyx
def test_repr(self):
di = self._gc_module.DeltaIndex('test text\n')
self.assertEqual('DeltaIndex(1, 10)', repr(di))
def test_make_delta(self):
di = self._gc_module.DeltaIndex(_text1)
delta = di.make_delta(_text2)
self.assertEqual('N\x90/\x1fdiffer from\nagainst other text\n', delta)
def test_delta_against_multiple_sources(self):
di = self._gc_module.DeltaIndex()
di.add_source(_first_text, 0)
self.assertEqual(len(_first_text), di._source_offset)
di.add_source(_second_text, 0)
self.assertEqual(len(_first_text) + len(_second_text),
di._source_offset)
delta = di.make_delta(_third_text)
result = self._gc_module.apply_delta(_first_text + _second_text, delta)
self.assertEqualDiff(_third_text, result)
self.assertEqual('\x85\x01\x90\x14\x0chas some in '
'\x91v6\x03and\x91d"\x91:\n', delta)
def test_delta_with_offsets(self):
di = self._gc_module.DeltaIndex()
di.add_source(_first_text, 5)
self.assertEqual(len(_first_text) + 5, di._source_offset)
di.add_source(_second_text, 10)
self.assertEqual(len(_first_text) + len(_second_text) + 15,
di._source_offset)
delta = di.make_delta(_third_text)
self.assertIsNot(None, delta)
result = self._gc_module.apply_delta(
'12345' + _first_text + '1234567890' + _second_text, delta)
self.assertIsNot(None, result)
self.assertEqualDiff(_third_text, result)
self.assertEqual('\x85\x01\x91\x05\x14\x0chas some in '
'\x91\x856\x03and\x91s"\x91?\n', delta)
def test_delta_with_delta_bytes(self):
di = self._gc_module.DeltaIndex()
source = _first_text
di.add_source(_first_text, 0)
self.assertEqual(len(_first_text), di._source_offset)
delta = di.make_delta(_second_text)
self.assertEqual('h\tsome more\x91\x019'
'&previous text\nand has some extra text\n', delta)
di.add_delta_source(delta, 0)
source += delta
self.assertEqual(len(_first_text) + len(delta), di._source_offset)
second_delta = di.make_delta(_third_text)
result = self._gc_module.apply_delta(source, second_delta)
self.assertEqualDiff(_third_text, result)
# We should be able to match against the
# 'previous text\nand has some...' that was part of the delta bytes
# Note that we don't match the 'common with the', because it isn't long
# enough to match in the original text, and those bytes are not present
# in the delta for the second text.
self.assertEqual('\x85\x01\x90\x14\x1chas some in common with the '
'\x91S&\x03and\x91\x18,', second_delta)
# Add this delta, and create a new delta for the same text. We should
# find the remaining text, and only insert the short 'and' text.
di.add_delta_source(second_delta, 0)
source += second_delta
third_delta = di.make_delta(_third_text)
result = self._gc_module.apply_delta(source, third_delta)
self.assertEqualDiff(_third_text, result)
self.assertEqual('\x85\x01\x90\x14\x91\x7e\x1c'
'\x91S&\x03and\x91\x18,', third_delta)
# Now create a delta, which we know won't be able to be 'fit' into the
# existing index
fourth_delta = di.make_delta(_fourth_text)
self.assertEqual(_fourth_text,
self._gc_module.apply_delta(source, fourth_delta))
self.assertEqual('\x80\x01'
'\x7f123456789012345\nsame rabin hash\n'
'123456789012345\nsame rabin hash\n'
'123456789012345\nsame rabin hash\n'
'123456789012345\nsame rabin hash'
'\x01\n', fourth_delta)
di.add_delta_source(fourth_delta, 0)
source += fourth_delta
# With the next delta, everything should be found
fifth_delta = di.make_delta(_fourth_text)
self.assertEqual(_fourth_text,
self._gc_module.apply_delta(source, fifth_delta))
self.assertEqual('\x80\x01\x91\xa7\x7f\x01\n', fifth_delta)
class TestCopyInstruction(tests.TestCase):
def assertEncode(self, expected, offset, length):
bytes = _groupcompress_py.encode_copy_instruction(offset, length)
if expected != bytes:
self.assertEqual([hex(ord(e)) for e in expected],
[hex(ord(b)) for b in bytes])
def assertDecode(self, exp_offset, exp_length, exp_newpos, bytes, pos):
cmd = ord(bytes[pos])
pos += 1
out = _groupcompress_py.decode_copy_instruction(bytes, cmd, pos)
self.assertEqual((exp_offset, exp_length, exp_newpos), out)
def test_encode_no_length(self):
self.assertEncode('\x80', 0, 64*1024)
self.assertEncode('\x81\x01', 1, 64*1024)
self.assertEncode('\x81\x0a', 10, 64*1024)
self.assertEncode('\x81\xff', 255, 64*1024)
self.assertEncode('\x82\x01', 256, 64*1024)
self.assertEncode('\x83\x01\x01', 257, 64*1024)
self.assertEncode('\x8F\xff\xff\xff\xff', 0xFFFFFFFF, 64*1024)
self.assertEncode('\x8E\xff\xff\xff', 0xFFFFFF00, 64*1024)
self.assertEncode('\x8D\xff\xff\xff', 0xFFFF00FF, 64*1024)
self.assertEncode('\x8B\xff\xff\xff', 0xFF00FFFF, 64*1024)
self.assertEncode('\x87\xff\xff\xff', 0x00FFFFFF, 64*1024)
self.assertEncode('\x8F\x04\x03\x02\x01', 0x01020304, 64*1024)
def test_encode_no_offset(self):
self.assertEncode('\x90\x01', 0, 1)
self.assertEncode('\x90\x0a', 0, 10)
self.assertEncode('\x90\xff', 0, 255)
self.assertEncode('\xA0\x01', 0, 256)
self.assertEncode('\xB0\x01\x01', 0, 257)
self.assertEncode('\xB0\xff\xff', 0, 0xFFFF)
# Special case, if copy == 64KiB, then we store exactly 0
# Note that this puns with a copy of exactly 0 bytes, but we don't care
# about that, as we would never actually copy 0 bytes
self.assertEncode('\x80', 0, 64*1024)
def test_encode(self):
self.assertEncode('\x91\x01\x01', 1, 1)
self.assertEncode('\x91\x09\x0a', 9, 10)
self.assertEncode('\x91\xfe\xff', 254, 255)
self.assertEncode('\xA2\x02\x01', 512, 256)
self.assertEncode('\xB3\x02\x01\x01\x01', 258, 257)
self.assertEncode('\xB0\x01\x01', 0, 257)
# Special case, if copy == 64KiB, then we store exactly 0
# Note that this puns with a copy of exactly 0 bytes, but we don't care
# about that, as we would never actually copy 0 bytes
self.assertEncode('\x81\x0a', 10, 64*1024)
def test_decode_no_length(self):
# If length is 0, it is interpreted as 64KiB
# The shortest possible instruction is a copy of 64KiB from offset 0
self.assertDecode(0, 65536, 1, '\x80', 0)
self.assertDecode(1, 65536, 2, '\x81\x01', 0)
self.assertDecode(10, 65536, 2, '\x81\x0a', 0)
self.assertDecode(255, 65536, 2, '\x81\xff', 0)
self.assertDecode(256, 65536, 2, '\x82\x01', 0)
self.assertDecode(257, 65536, 3, '\x83\x01\x01', 0)
self.assertDecode(0xFFFFFFFF, 65536, 5, '\x8F\xff\xff\xff\xff', 0)
self.assertDecode(0xFFFFFF00, 65536, 4, '\x8E\xff\xff\xff', 0)
self.assertDecode(0xFFFF00FF, 65536, 4, '\x8D\xff\xff\xff', 0)
self.assertDecode(0xFF00FFFF, 65536, 4, '\x8B\xff\xff\xff', 0)
self.assertDecode(0x00FFFFFF, 65536, 4, '\x87\xff\xff\xff', 0)
self.assertDecode(0x01020304, 65536, 5, '\x8F\x04\x03\x02\x01', 0)
def test_decode_no_offset(self):
self.assertDecode(0, 1, 2, '\x90\x01', 0)
self.assertDecode(0, 10, 2, '\x90\x0a', 0)
self.assertDecode(0, 255, 2, '\x90\xff', 0)
self.assertDecode(0, 256, 2, '\xA0\x01', 0)
self.assertDecode(0, 257, 3, '\xB0\x01\x01', 0)
self.assertDecode(0, 65535, 3, '\xB0\xff\xff', 0)
# Special case, if copy == 64KiB, then we store exactly 0
# Note that this puns with a copy of exactly 0 bytes, but we don't care
# about that, as we would never actually copy 0 bytes
self.assertDecode(0, 65536, 1, '\x80', 0)
def test_decode(self):
self.assertDecode(1, 1, 3, '\x91\x01\x01', 0)
self.assertDecode(9, 10, 3, '\x91\x09\x0a', 0)
self.assertDecode(254, 255, 3, '\x91\xfe\xff', 0)
self.assertDecode(512, 256, 3, '\xA2\x02\x01', 0)
self.assertDecode(258, 257, 5, '\xB3\x02\x01\x01\x01', 0)
self.assertDecode(0, 257, 3, '\xB0\x01\x01', 0)
def test_decode_not_start(self):
self.assertDecode(1, 1, 6, 'abc\x91\x01\x01def', 3)
self.assertDecode(9, 10, 5, 'ab\x91\x09\x0ade', 2)
self.assertDecode(254, 255, 6, 'not\x91\xfe\xffcopy', 3)
class TestBase128Int(tests.TestCase):
_gc_module = None # Set by load_tests
def assertEqualEncode(self, bytes, val):
self.assertEqual(bytes, self._gc_module.encode_base128_int(val))
def assertEqualDecode(self, val, num_decode, bytes):
self.assertEqual((val, num_decode),
self._gc_module.decode_base128_int(bytes))
def test_encode(self):
self.assertEqualEncode('\x01', 1)
self.assertEqualEncode('\x02', 2)
self.assertEqualEncode('\x7f', 127)
self.assertEqualEncode('\x80\x01', 128)
self.assertEqualEncode('\xff\x01', 255)
self.assertEqualEncode('\x80\x02', 256)
self.assertEqualEncode('\xff\xff\xff\xff\x0f', 0xFFFFFFFF)
def test_decode(self):
self.assertEqualDecode(1, 1, '\x01')
self.assertEqualDecode(2, 1, '\x02')
self.assertEqualDecode(127, 1, '\x7f')
self.assertEqualDecode(128, 2, '\x80\x01')
self.assertEqualDecode(255, 2, '\xff\x01')
self.assertEqualDecode(256, 2, '\x80\x02')
self.assertEqualDecode(0xFFFFFFFF, 5, '\xff\xff\xff\xff\x0f')
def test_decode_with_trailing_bytes(self):
self.assertEqualDecode(1, 1, '\x01abcdef')
self.assertEqualDecode(127, 1, '\x7f\x01')
self.assertEqualDecode(128, 2, '\x80\x01abcdef')
self.assertEqualDecode(255, 2, '\xff\x01\xff')
|