1
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Tests for Knit data structure"""
19
from cStringIO import StringIO
27
from bzrlib.errors import (
28
RevisionAlreadyPresent,
33
from bzrlib.knit import (
42
from bzrlib.osutils import split_lines
43
from bzrlib.tests import TestCase, TestCaseWithTransport
44
from bzrlib.transport import TransportLogger, get_transport
45
from bzrlib.transport.memory import MemoryTransport
46
from bzrlib.weave import Weave
49
class KnitContentTests(TestCase):
51
def test_constructor(self):
52
content = KnitContent([])
55
content = KnitContent([])
56
self.assertEqual(content.text(), [])
58
content = KnitContent([("origin1", "text1"), ("origin2", "text2")])
59
self.assertEqual(content.text(), ["text1", "text2"])
61
def test_annotate(self):
62
content = KnitContent([])
63
self.assertEqual(content.annotate(), [])
65
content = KnitContent([("origin1", "text1"), ("origin2", "text2")])
66
self.assertEqual(content.annotate(),
67
[("origin1", "text1"), ("origin2", "text2")])
69
def test_annotate_iter(self):
70
content = KnitContent([])
71
it = content.annotate_iter()
72
self.assertRaises(StopIteration, it.next)
74
content = KnitContent([("origin1", "text1"), ("origin2", "text2")])
75
it = content.annotate_iter()
76
self.assertEqual(it.next(), ("origin1", "text1"))
77
self.assertEqual(it.next(), ("origin2", "text2"))
78
self.assertRaises(StopIteration, it.next)
81
content = KnitContent([("origin1", "text1"), ("origin2", "text2")])
83
self.assertIsInstance(copy, KnitContent)
84
self.assertEqual(copy.annotate(),
85
[("origin1", "text1"), ("origin2", "text2")])
87
def test_line_delta(self):
88
content1 = KnitContent([("", "a"), ("", "b")])
89
content2 = KnitContent([("", "a"), ("", "a"), ("", "c")])
90
self.assertEqual(content1.line_delta(content2),
91
[(1, 2, 2, [("", "a"), ("", "c")])])
93
def test_line_delta_iter(self):
94
content1 = KnitContent([("", "a"), ("", "b")])
95
content2 = KnitContent([("", "a"), ("", "a"), ("", "c")])
96
it = content1.line_delta_iter(content2)
97
self.assertEqual(it.next(), (1, 2, 2, [("", "a"), ("", "c")]))
98
self.assertRaises(StopIteration, it.next)
101
class MockTransport(object):
103
def __init__(self, file_lines=None):
104
self.file_lines = file_lines
106
# We have no base directory for the MockTransport
109
def get(self, filename):
110
if self.file_lines is None:
111
raise NoSuchFile(filename)
113
return StringIO("\n".join(self.file_lines))
115
def readv(self, relpath, offsets):
116
fp = self.get(relpath)
117
for offset, size in offsets:
119
yield offset, fp.read(size)
121
def __getattr__(self, name):
122
def queue_call(*args, **kwargs):
123
self.calls.append((name, args, kwargs))
127
class LowLevelKnitDataTests(TestCase):
129
def create_gz_content(self, text):
131
gz_file = gzip.GzipFile(mode='wb', fileobj=sio)
134
return sio.getvalue()
136
def test_valid_knit_data(self):
137
sha1sum = sha.new('foo\nbar\n').hexdigest()
138
gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
143
transport = MockTransport([gz_txt])
144
data = _KnitData(transport, 'filename', mode='r')
145
records = [('rev-id-1', 0, len(gz_txt))]
147
contents = data.read_records(records)
148
self.assertEqual({'rev-id-1':(['foo\n', 'bar\n'], sha1sum)}, contents)
150
raw_contents = list(data.read_records_iter_raw(records))
151
self.assertEqual([('rev-id-1', gz_txt)], raw_contents)
153
def test_not_enough_lines(self):
154
sha1sum = sha.new('foo\n').hexdigest()
155
# record says 2 lines data says 1
156
gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
160
transport = MockTransport([gz_txt])
161
data = _KnitData(transport, 'filename', mode='r')
162
records = [('rev-id-1', 0, len(gz_txt))]
163
self.assertRaises(errors.KnitCorrupt, data.read_records, records)
165
# read_records_iter_raw won't detect that sort of mismatch/corruption
166
raw_contents = list(data.read_records_iter_raw(records))
167
self.assertEqual([('rev-id-1', gz_txt)], raw_contents)
169
def test_too_many_lines(self):
170
sha1sum = sha.new('foo\nbar\n').hexdigest()
171
# record says 1 lines data says 2
172
gz_txt = self.create_gz_content('version rev-id-1 1 %s\n'
177
transport = MockTransport([gz_txt])
178
data = _KnitData(transport, 'filename', mode='r')
179
records = [('rev-id-1', 0, len(gz_txt))]
180
self.assertRaises(errors.KnitCorrupt, data.read_records, records)
182
# read_records_iter_raw won't detect that sort of mismatch/corruption
183
raw_contents = list(data.read_records_iter_raw(records))
184
self.assertEqual([('rev-id-1', gz_txt)], raw_contents)
186
def test_mismatched_version_id(self):
187
sha1sum = sha.new('foo\nbar\n').hexdigest()
188
gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
193
transport = MockTransport([gz_txt])
194
data = _KnitData(transport, 'filename', mode='r')
195
# We are asking for rev-id-2, but the data is rev-id-1
196
records = [('rev-id-2', 0, len(gz_txt))]
197
self.assertRaises(errors.KnitCorrupt, data.read_records, records)
199
# read_records_iter_raw will notice if we request the wrong version.
200
self.assertRaises(errors.KnitCorrupt, list,
201
data.read_records_iter_raw(records))
203
def test_uncompressed_data(self):
204
sha1sum = sha.new('foo\nbar\n').hexdigest()
205
txt = ('version rev-id-1 2 %s\n'
210
transport = MockTransport([txt])
211
data = _KnitData(transport, 'filename', mode='r')
212
records = [('rev-id-1', 0, len(txt))]
214
# We don't have valid gzip data ==> corrupt
215
self.assertRaises(errors.KnitCorrupt, data.read_records, records)
217
# read_records_iter_raw will notice the bad data
218
self.assertRaises(errors.KnitCorrupt, list,
219
data.read_records_iter_raw(records))
221
def test_corrupted_data(self):
222
sha1sum = sha.new('foo\nbar\n').hexdigest()
223
gz_txt = self.create_gz_content('version rev-id-1 2 %s\n'
228
# Change 2 bytes in the middle to \xff
229
gz_txt = gz_txt[:10] + '\xff\xff' + gz_txt[12:]
230
transport = MockTransport([gz_txt])
231
data = _KnitData(transport, 'filename', mode='r')
232
records = [('rev-id-1', 0, len(gz_txt))]
234
self.assertRaises(errors.KnitCorrupt, data.read_records, records)
236
# read_records_iter_raw will notice if we request the wrong version.
237
self.assertRaises(errors.KnitCorrupt, list,
238
data.read_records_iter_raw(records))
241
class LowLevelKnitIndexTests(TestCase):
243
def test_no_such_file(self):
244
transport = MockTransport()
246
self.assertRaises(NoSuchFile, _KnitIndex, transport, "filename", "r")
247
self.assertRaises(NoSuchFile, _KnitIndex, transport,
248
"filename", "w", create=False)
250
def test_create_file(self):
251
transport = MockTransport()
253
index = _KnitIndex(transport, "filename", "w",
254
file_mode="wb", create=True)
256
("put_bytes_non_atomic",
257
("filename", index.HEADER), {"mode": "wb"}),
258
transport.calls.pop(0))
260
def test_delay_create_file(self):
261
transport = MockTransport()
263
index = _KnitIndex(transport, "filename", "w",
264
create=True, file_mode="wb", create_parent_dir=True,
265
delay_create=True, dir_mode=0777)
266
self.assertEqual([], transport.calls)
268
index.add_versions([])
269
name, (filename, f), kwargs = transport.calls.pop(0)
270
self.assertEqual("put_file_non_atomic", name)
272
{"dir_mode": 0777, "create_parent_dir": True, "mode": "wb"},
274
self.assertEqual("filename", filename)
275
self.assertEqual(index.HEADER, f.read())
277
index.add_versions([])
278
self.assertEqual(("append_bytes", ("filename", ""), {}),
279
transport.calls.pop(0))
281
def test_read_utf8_version_id(self):
282
unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
283
utf8_revision_id = unicode_revision_id.encode('utf-8')
284
transport = MockTransport([
286
'%s option 0 1 :' % (utf8_revision_id,)
288
index = _KnitIndex(transport, "filename", "r")
289
# _KnitIndex is a private class, and deals in utf8 revision_ids, not
290
# Unicode revision_ids.
291
self.assertTrue(index.has_version(utf8_revision_id))
292
self.assertFalse(index.has_version(unicode_revision_id))
294
def test_read_utf8_parents(self):
295
unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
296
utf8_revision_id = unicode_revision_id.encode('utf-8')
297
transport = MockTransport([
299
"version option 0 1 .%s :" % (utf8_revision_id,)
301
index = _KnitIndex(transport, "filename", "r")
302
self.assertEqual([utf8_revision_id],
303
index.get_parents_with_ghosts("version"))
305
def test_read_ignore_corrupted_lines(self):
306
transport = MockTransport([
309
"corrupted options 0 1 .b .c ",
310
"version options 0 1 :"
312
index = _KnitIndex(transport, "filename", "r")
313
self.assertEqual(1, index.num_versions())
314
self.assertTrue(index.has_version("version"))
316
def test_read_corrupted_header(self):
317
transport = MockTransport(['not a bzr knit index header\n'])
318
self.assertRaises(KnitHeaderError,
319
_KnitIndex, transport, "filename", "r")
321
def test_read_duplicate_entries(self):
322
transport = MockTransport([
324
"parent options 0 1 :",
325
"version options1 0 1 0 :",
326
"version options2 1 2 .other :",
327
"version options3 3 4 0 .other :"
329
index = _KnitIndex(transport, "filename", "r")
330
self.assertEqual(2, index.num_versions())
331
self.assertEqual(1, index.lookup("version"))
332
self.assertEqual((3, 4), index.get_position("version"))
333
self.assertEqual(["options3"], index.get_options("version"))
334
self.assertEqual(["parent", "other"],
335
index.get_parents_with_ghosts("version"))
337
def test_read_compressed_parents(self):
338
transport = MockTransport([
342
"c option 0 1 1 0 :",
344
index = _KnitIndex(transport, "filename", "r")
345
self.assertEqual(["a"], index.get_parents("b"))
346
self.assertEqual(["b", "a"], index.get_parents("c"))
348
def test_write_utf8_version_id(self):
349
unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
350
utf8_revision_id = unicode_revision_id.encode('utf-8')
351
transport = MockTransport([
354
index = _KnitIndex(transport, "filename", "r")
355
index.add_version(utf8_revision_id, ["option"], 0, 1, [])
356
self.assertEqual(("append_bytes", ("filename",
357
"\n%s option 0 1 :" % (utf8_revision_id,)),
359
transport.calls.pop(0))
361
def test_write_utf8_parents(self):
362
unicode_revision_id = u"version-\N{CYRILLIC CAPITAL LETTER A}"
363
utf8_revision_id = unicode_revision_id.encode('utf-8')
364
transport = MockTransport([
367
index = _KnitIndex(transport, "filename", "r")
368
index.add_version("version", ["option"], 0, 1, [utf8_revision_id])
369
self.assertEqual(("append_bytes", ("filename",
370
"\nversion option 0 1 .%s :" % (utf8_revision_id,)),
372
transport.calls.pop(0))
374
def test_get_graph(self):
375
transport = MockTransport()
376
index = _KnitIndex(transport, "filename", "w", create=True)
377
self.assertEqual([], index.get_graph())
379
index.add_version("a", ["option"], 0, 1, ["b"])
380
self.assertEqual([("a", ["b"])], index.get_graph())
382
index.add_version("c", ["option"], 0, 1, ["d"])
383
self.assertEqual([("a", ["b"]), ("c", ["d"])],
384
sorted(index.get_graph()))
386
def test_get_ancestry(self):
387
transport = MockTransport([
390
"b option 0 1 0 .e :",
391
"c option 0 1 1 0 :",
392
"d option 0 1 2 .f :"
394
index = _KnitIndex(transport, "filename", "r")
396
self.assertEqual([], index.get_ancestry([]))
397
self.assertEqual(["a"], index.get_ancestry(["a"]))
398
self.assertEqual(["a", "b"], index.get_ancestry(["b"]))
399
self.assertEqual(["a", "b", "c"], index.get_ancestry(["c"]))
400
self.assertEqual(["a", "b", "c", "d"], index.get_ancestry(["d"]))
401
self.assertEqual(["a", "b"], index.get_ancestry(["a", "b"]))
402
self.assertEqual(["a", "b", "c"], index.get_ancestry(["a", "c"]))
404
self.assertRaises(RevisionNotPresent, index.get_ancestry, ["e"])
406
def test_get_ancestry_with_ghosts(self):
407
transport = MockTransport([
410
"b option 0 1 0 .e :",
411
"c option 0 1 0 .f .g :",
412
"d option 0 1 2 .h .j .k :"
414
index = _KnitIndex(transport, "filename", "r")
416
self.assertEqual([], index.get_ancestry_with_ghosts([]))
417
self.assertEqual(["a"], index.get_ancestry_with_ghosts(["a"]))
418
self.assertEqual(["a", "e", "b"],
419
index.get_ancestry_with_ghosts(["b"]))
420
self.assertEqual(["a", "g", "f", "c"],
421
index.get_ancestry_with_ghosts(["c"]))
422
self.assertEqual(["a", "g", "f", "c", "k", "j", "h", "d"],
423
index.get_ancestry_with_ghosts(["d"]))
424
self.assertEqual(["a", "e", "b"],
425
index.get_ancestry_with_ghosts(["a", "b"]))
426
self.assertEqual(["a", "g", "f", "c"],
427
index.get_ancestry_with_ghosts(["a", "c"]))
429
["a", "g", "f", "c", "e", "b", "k", "j", "h", "d"],
430
index.get_ancestry_with_ghosts(["b", "d"]))
432
self.assertRaises(RevisionNotPresent,
433
index.get_ancestry_with_ghosts, ["e"])
435
def test_num_versions(self):
436
transport = MockTransport([
439
index = _KnitIndex(transport, "filename", "r")
441
self.assertEqual(0, index.num_versions())
442
self.assertEqual(0, len(index))
444
index.add_version("a", ["option"], 0, 1, [])
445
self.assertEqual(1, index.num_versions())
446
self.assertEqual(1, len(index))
448
index.add_version("a", ["option2"], 1, 2, [])
449
self.assertEqual(1, index.num_versions())
450
self.assertEqual(1, len(index))
452
index.add_version("b", ["option"], 0, 1, [])
453
self.assertEqual(2, index.num_versions())
454
self.assertEqual(2, len(index))
456
def test_get_versions(self):
457
transport = MockTransport([
460
index = _KnitIndex(transport, "filename", "r")
462
self.assertEqual([], index.get_versions())
464
index.add_version("a", ["option"], 0, 1, [])
465
self.assertEqual(["a"], index.get_versions())
467
index.add_version("a", ["option"], 0, 1, [])
468
self.assertEqual(["a"], index.get_versions())
470
index.add_version("b", ["option"], 0, 1, [])
471
self.assertEqual(["a", "b"], index.get_versions())
473
def test_idx_to_name(self):
474
transport = MockTransport([
479
index = _KnitIndex(transport, "filename", "r")
481
self.assertEqual("a", index.idx_to_name(0))
482
self.assertEqual("b", index.idx_to_name(1))
483
self.assertEqual("b", index.idx_to_name(-1))
484
self.assertEqual("a", index.idx_to_name(-2))
486
def test_lookup(self):
487
transport = MockTransport([
492
index = _KnitIndex(transport, "filename", "r")
494
self.assertEqual(0, index.lookup("a"))
495
self.assertEqual(1, index.lookup("b"))
497
def test_add_version(self):
498
transport = MockTransport([
501
index = _KnitIndex(transport, "filename", "r")
503
index.add_version("a", ["option"], 0, 1, ["b"])
504
self.assertEqual(("append_bytes",
505
("filename", "\na option 0 1 .b :"),
506
{}), transport.calls.pop(0))
507
self.assertTrue(index.has_version("a"))
508
self.assertEqual(1, index.num_versions())
509
self.assertEqual((0, 1), index.get_position("a"))
510
self.assertEqual(["option"], index.get_options("a"))
511
self.assertEqual(["b"], index.get_parents_with_ghosts("a"))
513
index.add_version("a", ["opt"], 1, 2, ["c"])
514
self.assertEqual(("append_bytes",
515
("filename", "\na opt 1 2 .c :"),
516
{}), transport.calls.pop(0))
517
self.assertTrue(index.has_version("a"))
518
self.assertEqual(1, index.num_versions())
519
self.assertEqual((1, 2), index.get_position("a"))
520
self.assertEqual(["opt"], index.get_options("a"))
521
self.assertEqual(["c"], index.get_parents_with_ghosts("a"))
523
index.add_version("b", ["option"], 2, 3, ["a"])
524
self.assertEqual(("append_bytes",
525
("filename", "\nb option 2 3 0 :"),
526
{}), transport.calls.pop(0))
527
self.assertTrue(index.has_version("b"))
528
self.assertEqual(2, index.num_versions())
529
self.assertEqual((2, 3), index.get_position("b"))
530
self.assertEqual(["option"], index.get_options("b"))
531
self.assertEqual(["a"], index.get_parents_with_ghosts("b"))
533
def test_add_versions(self):
534
transport = MockTransport([
537
index = _KnitIndex(transport, "filename", "r")
540
("a", ["option"], 0, 1, ["b"]),
541
("a", ["opt"], 1, 2, ["c"]),
542
("b", ["option"], 2, 3, ["a"])
544
self.assertEqual(("append_bytes", ("filename",
545
"\na option 0 1 .b :"
548
), {}), transport.calls.pop(0))
549
self.assertTrue(index.has_version("a"))
550
self.assertTrue(index.has_version("b"))
551
self.assertEqual(2, index.num_versions())
552
self.assertEqual((1, 2), index.get_position("a"))
553
self.assertEqual((2, 3), index.get_position("b"))
554
self.assertEqual(["opt"], index.get_options("a"))
555
self.assertEqual(["option"], index.get_options("b"))
556
self.assertEqual(["c"], index.get_parents_with_ghosts("a"))
557
self.assertEqual(["a"], index.get_parents_with_ghosts("b"))
559
def test_delay_create_and_add_versions(self):
560
transport = MockTransport()
562
index = _KnitIndex(transport, "filename", "w",
563
create=True, file_mode="wb", create_parent_dir=True,
564
delay_create=True, dir_mode=0777)
565
self.assertEqual([], transport.calls)
568
("a", ["option"], 0, 1, ["b"]),
569
("a", ["opt"], 1, 2, ["c"]),
570
("b", ["option"], 2, 3, ["a"])
572
name, (filename, f), kwargs = transport.calls.pop(0)
573
self.assertEqual("put_file_non_atomic", name)
575
{"dir_mode": 0777, "create_parent_dir": True, "mode": "wb"},
577
self.assertEqual("filename", filename)
580
"\na option 0 1 .b :"
582
"\nb option 2 3 0 :",
585
def test_has_version(self):
586
transport = MockTransport([
590
index = _KnitIndex(transport, "filename", "r")
592
self.assertTrue(index.has_version("a"))
593
self.assertFalse(index.has_version("b"))
595
def test_get_position(self):
596
transport = MockTransport([
601
index = _KnitIndex(transport, "filename", "r")
603
self.assertEqual((0, 1), index.get_position("a"))
604
self.assertEqual((1, 2), index.get_position("b"))
606
def test_get_method(self):
607
transport = MockTransport([
609
"a fulltext,unknown 0 1 :",
610
"b unknown,line-delta 1 2 :",
613
index = _KnitIndex(transport, "filename", "r")
615
self.assertEqual("fulltext", index.get_method("a"))
616
self.assertEqual("line-delta", index.get_method("b"))
617
self.assertRaises(errors.KnitIndexUnknownMethod, index.get_method, "c")
619
def test_get_options(self):
620
transport = MockTransport([
625
index = _KnitIndex(transport, "filename", "r")
627
self.assertEqual(["opt1"], index.get_options("a"))
628
self.assertEqual(["opt2", "opt3"], index.get_options("b"))
630
def test_get_parents(self):
631
transport = MockTransport([
634
"b option 1 2 0 .c :",
635
"c option 1 2 1 0 .e :"
637
index = _KnitIndex(transport, "filename", "r")
639
self.assertEqual([], index.get_parents("a"))
640
self.assertEqual(["a", "c"], index.get_parents("b"))
641
self.assertEqual(["b", "a"], index.get_parents("c"))
643
def test_get_parents_with_ghosts(self):
644
transport = MockTransport([
647
"b option 1 2 0 .c :",
648
"c option 1 2 1 0 .e :"
650
index = _KnitIndex(transport, "filename", "r")
652
self.assertEqual([], index.get_parents_with_ghosts("a"))
653
self.assertEqual(["a", "c"], index.get_parents_with_ghosts("b"))
654
self.assertEqual(["b", "a", "e"],
655
index.get_parents_with_ghosts("c"))
657
def test_check_versions_present(self):
658
transport = MockTransport([
663
index = _KnitIndex(transport, "filename", "r")
665
check = index.check_versions_present
671
self.assertRaises(RevisionNotPresent, check, ["c"])
672
self.assertRaises(RevisionNotPresent, check, ["a", "b", "c"])
675
class KnitTests(TestCaseWithTransport):
676
"""Class containing knit test helper routines."""
678
def make_test_knit(self, annotate=False, delay_create=False):
680
factory = KnitPlainFactory()
683
return KnitVersionedFile('test', get_transport('.'), access_mode='w',
684
factory=factory, create=True,
685
delay_create=delay_create)
688
class BasicKnitTests(KnitTests):
690
def add_stock_one_and_one_a(self, k):
691
k.add_lines('text-1', [], split_lines(TEXT_1))
692
k.add_lines('text-1a', ['text-1'], split_lines(TEXT_1A))
694
def test_knit_constructor(self):
695
"""Construct empty k"""
696
self.make_test_knit()
698
def test_knit_add(self):
699
"""Store one text in knit and retrieve"""
700
k = self.make_test_knit()
701
k.add_lines('text-1', [], split_lines(TEXT_1))
702
self.assertTrue(k.has_version('text-1'))
703
self.assertEqualDiff(''.join(k.get_lines('text-1')), TEXT_1)
705
def test_knit_reload(self):
706
# test that the content in a reloaded knit is correct
707
k = self.make_test_knit()
708
k.add_lines('text-1', [], split_lines(TEXT_1))
710
k2 = KnitVersionedFile('test', get_transport('.'), access_mode='r', factory=KnitPlainFactory(), create=True)
711
self.assertTrue(k2.has_version('text-1'))
712
self.assertEqualDiff(''.join(k2.get_lines('text-1')), TEXT_1)
714
def test_knit_several(self):
715
"""Store several texts in a knit"""
716
k = self.make_test_knit()
717
k.add_lines('text-1', [], split_lines(TEXT_1))
718
k.add_lines('text-2', [], split_lines(TEXT_2))
719
self.assertEqualDiff(''.join(k.get_lines('text-1')), TEXT_1)
720
self.assertEqualDiff(''.join(k.get_lines('text-2')), TEXT_2)
722
def test_repeated_add(self):
723
"""Knit traps attempt to replace existing version"""
724
k = self.make_test_knit()
725
k.add_lines('text-1', [], split_lines(TEXT_1))
726
self.assertRaises(RevisionAlreadyPresent,
728
'text-1', [], split_lines(TEXT_1))
730
def test_empty(self):
731
k = self.make_test_knit(True)
732
k.add_lines('text-1', [], [])
733
self.assertEquals(k.get_lines('text-1'), [])
735
def test_incomplete(self):
736
"""Test if texts without a ending line-end can be inserted and
738
k = KnitVersionedFile('test', get_transport('.'), delta=False, create=True)
739
k.add_lines('text-1', [], ['a\n', 'b' ])
740
k.add_lines('text-2', ['text-1'], ['a\rb\n', 'b\n'])
741
# reopening ensures maximum room for confusion
742
k = KnitVersionedFile('test', get_transport('.'), delta=False, create=True)
743
self.assertEquals(k.get_lines('text-1'), ['a\n', 'b' ])
744
self.assertEquals(k.get_lines('text-2'), ['a\rb\n', 'b\n'])
746
def test_delta(self):
747
"""Expression of knit delta as lines"""
748
k = self.make_test_knit()
749
td = list(line_delta(TEXT_1.splitlines(True),
750
TEXT_1A.splitlines(True)))
751
self.assertEqualDiff(''.join(td), delta_1_1a)
752
out = apply_line_delta(TEXT_1.splitlines(True), td)
753
self.assertEqualDiff(''.join(out), TEXT_1A)
755
def test_add_with_parents(self):
756
"""Store in knit with parents"""
757
k = self.make_test_knit()
758
self.add_stock_one_and_one_a(k)
759
self.assertEquals(k.get_parents('text-1'), [])
760
self.assertEquals(k.get_parents('text-1a'), ['text-1'])
762
def test_ancestry(self):
763
"""Store in knit with parents"""
764
k = self.make_test_knit()
765
self.add_stock_one_and_one_a(k)
766
self.assertEquals(set(k.get_ancestry(['text-1a'])), set(['text-1a', 'text-1']))
768
def test_add_delta(self):
769
"""Store in knit with parents"""
770
k = KnitVersionedFile('test', get_transport('.'), factory=KnitPlainFactory(),
771
delta=True, create=True)
772
self.add_stock_one_and_one_a(k)
774
self.assertEqualDiff(''.join(k.get_lines('text-1a')), TEXT_1A)
776
def test_annotate(self):
778
k = KnitVersionedFile('knit', get_transport('.'), factory=KnitAnnotateFactory(),
779
delta=True, create=True)
780
self.insert_and_test_small_annotate(k)
782
def insert_and_test_small_annotate(self, k):
783
"""test annotation with k works correctly."""
784
k.add_lines('text-1', [], ['a\n', 'b\n'])
785
k.add_lines('text-2', ['text-1'], ['a\n', 'c\n'])
787
origins = k.annotate('text-2')
788
self.assertEquals(origins[0], ('text-1', 'a\n'))
789
self.assertEquals(origins[1], ('text-2', 'c\n'))
791
def test_annotate_fulltext(self):
793
k = KnitVersionedFile('knit', get_transport('.'), factory=KnitAnnotateFactory(),
794
delta=False, create=True)
795
self.insert_and_test_small_annotate(k)
797
def test_annotate_merge_1(self):
798
k = self.make_test_knit(True)
799
k.add_lines('text-a1', [], ['a\n', 'b\n'])
800
k.add_lines('text-a2', [], ['d\n', 'c\n'])
801
k.add_lines('text-am', ['text-a1', 'text-a2'], ['d\n', 'b\n'])
802
origins = k.annotate('text-am')
803
self.assertEquals(origins[0], ('text-a2', 'd\n'))
804
self.assertEquals(origins[1], ('text-a1', 'b\n'))
806
def test_annotate_merge_2(self):
807
k = self.make_test_knit(True)
808
k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
809
k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
810
k.add_lines('text-am', ['text-a1', 'text-a2'], ['a\n', 'y\n', 'c\n'])
811
origins = k.annotate('text-am')
812
self.assertEquals(origins[0], ('text-a1', 'a\n'))
813
self.assertEquals(origins[1], ('text-a2', 'y\n'))
814
self.assertEquals(origins[2], ('text-a1', 'c\n'))
816
def test_annotate_merge_9(self):
817
k = self.make_test_knit(True)
818
k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
819
k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
820
k.add_lines('text-am', ['text-a1', 'text-a2'], ['k\n', 'y\n', 'c\n'])
821
origins = k.annotate('text-am')
822
self.assertEquals(origins[0], ('text-am', 'k\n'))
823
self.assertEquals(origins[1], ('text-a2', 'y\n'))
824
self.assertEquals(origins[2], ('text-a1', 'c\n'))
826
def test_annotate_merge_3(self):
827
k = self.make_test_knit(True)
828
k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
829
k.add_lines('text-a2', [] ,['x\n', 'y\n', 'z\n'])
830
k.add_lines('text-am', ['text-a1', 'text-a2'], ['k\n', 'y\n', 'z\n'])
831
origins = k.annotate('text-am')
832
self.assertEquals(origins[0], ('text-am', 'k\n'))
833
self.assertEquals(origins[1], ('text-a2', 'y\n'))
834
self.assertEquals(origins[2], ('text-a2', 'z\n'))
836
def test_annotate_merge_4(self):
837
k = self.make_test_knit(True)
838
k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
839
k.add_lines('text-a2', [], ['x\n', 'y\n', 'z\n'])
840
k.add_lines('text-a3', ['text-a1'], ['a\n', 'b\n', 'p\n'])
841
k.add_lines('text-am', ['text-a2', 'text-a3'], ['a\n', 'b\n', 'z\n'])
842
origins = k.annotate('text-am')
843
self.assertEquals(origins[0], ('text-a1', 'a\n'))
844
self.assertEquals(origins[1], ('text-a1', 'b\n'))
845
self.assertEquals(origins[2], ('text-a2', 'z\n'))
847
def test_annotate_merge_5(self):
848
k = self.make_test_knit(True)
849
k.add_lines('text-a1', [], ['a\n', 'b\n', 'c\n'])
850
k.add_lines('text-a2', [], ['d\n', 'e\n', 'f\n'])
851
k.add_lines('text-a3', [], ['x\n', 'y\n', 'z\n'])
852
k.add_lines('text-am',
853
['text-a1', 'text-a2', 'text-a3'],
854
['a\n', 'e\n', 'z\n'])
855
origins = k.annotate('text-am')
856
self.assertEquals(origins[0], ('text-a1', 'a\n'))
857
self.assertEquals(origins[1], ('text-a2', 'e\n'))
858
self.assertEquals(origins[2], ('text-a3', 'z\n'))
860
def test_annotate_file_cherry_pick(self):
861
k = self.make_test_knit(True)
862
k.add_lines('text-1', [], ['a\n', 'b\n', 'c\n'])
863
k.add_lines('text-2', ['text-1'], ['d\n', 'e\n', 'f\n'])
864
k.add_lines('text-3', ['text-2', 'text-1'], ['a\n', 'b\n', 'c\n'])
865
origins = k.annotate('text-3')
866
self.assertEquals(origins[0], ('text-1', 'a\n'))
867
self.assertEquals(origins[1], ('text-1', 'b\n'))
868
self.assertEquals(origins[2], ('text-1', 'c\n'))
870
def test_knit_join(self):
871
"""Store in knit with parents"""
872
k1 = KnitVersionedFile('test1', get_transport('.'), factory=KnitPlainFactory(), create=True)
873
k1.add_lines('text-a', [], split_lines(TEXT_1))
874
k1.add_lines('text-b', ['text-a'], split_lines(TEXT_1))
876
k1.add_lines('text-c', [], split_lines(TEXT_1))
877
k1.add_lines('text-d', ['text-c'], split_lines(TEXT_1))
879
k1.add_lines('text-m', ['text-b', 'text-d'], split_lines(TEXT_1))
881
k2 = KnitVersionedFile('test2', get_transport('.'), factory=KnitPlainFactory(), create=True)
882
count = k2.join(k1, version_ids=['text-m'])
883
self.assertEquals(count, 5)
884
self.assertTrue(k2.has_version('text-a'))
885
self.assertTrue(k2.has_version('text-c'))
887
def test_reannotate(self):
888
k1 = KnitVersionedFile('knit1', get_transport('.'),
889
factory=KnitAnnotateFactory(), create=True)
891
k1.add_lines('text-a', [], ['a\n', 'b\n'])
893
k1.add_lines('text-b', ['text-a'], ['a\n', 'c\n'])
895
k2 = KnitVersionedFile('test2', get_transport('.'),
896
factory=KnitAnnotateFactory(), create=True)
897
k2.join(k1, version_ids=['text-b'])
900
k1.add_lines('text-X', ['text-b'], ['a\n', 'b\n'])
902
k2.add_lines('text-c', ['text-b'], ['z\n', 'c\n'])
904
k2.add_lines('text-Y', ['text-b'], ['b\n', 'c\n'])
906
# test-c will have index 3
907
k1.join(k2, version_ids=['text-c'])
909
lines = k1.get_lines('text-c')
910
self.assertEquals(lines, ['z\n', 'c\n'])
912
origins = k1.annotate('text-c')
913
self.assertEquals(origins[0], ('text-c', 'z\n'))
914
self.assertEquals(origins[1], ('text-b', 'c\n'))
916
def test_get_line_delta_texts(self):
917
"""Make sure we can call get_texts on text with reused line deltas"""
918
k1 = KnitVersionedFile('test1', get_transport('.'),
919
factory=KnitPlainFactory(), create=True)
924
parents = ['%d' % (t-1)]
925
k1.add_lines('%d' % t, parents, ['hello\n'] * t)
926
k1.get_texts(('%d' % t) for t in range(3))
928
def test_iter_lines_reads_in_order(self):
929
t = MemoryTransport()
930
instrumented_t = TransportLogger(t)
931
k1 = KnitVersionedFile('id', instrumented_t, create=True, delta=True)
932
self.assertEqual([('id.kndx',)], instrumented_t._calls)
933
# add texts with no required ordering
934
k1.add_lines('base', [], ['text\n'])
935
k1.add_lines('base2', [], ['text2\n'])
937
instrumented_t._calls = []
938
# request a last-first iteration
939
results = list(k1.iter_lines_added_or_present_in_versions(['base2', 'base']))
940
self.assertEqual([('id.knit', [(0, 87), (87, 89)])], instrumented_t._calls)
941
self.assertEqual(['text\n', 'text2\n'], results)
943
def test_create_empty_annotated(self):
944
k1 = self.make_test_knit(True)
946
k1.add_lines('text-a', [], ['a\n', 'b\n'])
947
k2 = k1.create_empty('t', MemoryTransport())
948
self.assertTrue(isinstance(k2.factory, KnitAnnotateFactory))
949
self.assertEqual(k1.delta, k2.delta)
950
# the generic test checks for empty content and file class
952
def test_knit_format(self):
953
# this tests that a new knit index file has the expected content
954
# and that is writes the data we expect as records are added.
955
knit = self.make_test_knit(True)
956
# Now knit files are not created until we first add data to them
957
self.assertFileEqual("# bzr knit index 8\n", 'test.kndx')
958
knit.add_lines_with_ghosts('revid', ['a_ghost'], ['a\n'])
959
self.assertFileEqual(
960
"# bzr knit index 8\n"
962
"revid fulltext 0 84 .a_ghost :",
964
knit.add_lines_with_ghosts('revid2', ['revid'], ['a\n'])
965
self.assertFileEqual(
966
"# bzr knit index 8\n"
967
"\nrevid fulltext 0 84 .a_ghost :"
968
"\nrevid2 line-delta 84 82 0 :",
970
# we should be able to load this file again
971
knit = KnitVersionedFile('test', get_transport('.'), access_mode='r')
972
self.assertEqual(['revid', 'revid2'], knit.versions())
973
# write a short write to the file and ensure that its ignored
974
indexfile = file('test.kndx', 'at')
975
indexfile.write('\nrevid3 line-delta 166 82 1 2 3 4 5 .phwoar:demo ')
977
# we should be able to load this file again
978
knit = KnitVersionedFile('test', get_transport('.'), access_mode='w')
979
self.assertEqual(['revid', 'revid2'], knit.versions())
980
# and add a revision with the same id the failed write had
981
knit.add_lines('revid3', ['revid2'], ['a\n'])
982
# and when reading it revid3 should now appear.
983
knit = KnitVersionedFile('test', get_transport('.'), access_mode='r')
984
self.assertEqual(['revid', 'revid2', 'revid3'], knit.versions())
985
self.assertEqual(['revid2'], knit.get_parents('revid3'))
987
def test_delay_create(self):
988
"""Test that passing delay_create=True creates files late"""
989
knit = self.make_test_knit(annotate=True, delay_create=True)
990
self.failIfExists('test.knit')
991
self.failIfExists('test.kndx')
992
knit.add_lines_with_ghosts('revid', ['a_ghost'], ['a\n'])
993
self.failUnlessExists('test.knit')
994
self.assertFileEqual(
995
"# bzr knit index 8\n"
997
"revid fulltext 0 84 .a_ghost :",
1000
def test_create_parent_dir(self):
1001
"""create_parent_dir can create knits in nonexistant dirs"""
1002
# Has no effect if we don't set 'delay_create'
1003
trans = get_transport('.')
1004
self.assertRaises(NoSuchFile, KnitVersionedFile, 'dir/test',
1005
trans, access_mode='w', factory=None,
1006
create=True, create_parent_dir=True)
1007
# Nothing should have changed yet
1008
knit = KnitVersionedFile('dir/test', trans, access_mode='w',
1009
factory=None, create=True,
1010
create_parent_dir=True,
1012
self.failIfExists('dir/test.knit')
1013
self.failIfExists('dir/test.kndx')
1014
self.failIfExists('dir')
1015
knit.add_lines('revid', [], ['a\n'])
1016
self.failUnlessExists('dir')
1017
self.failUnlessExists('dir/test.knit')
1018
self.assertFileEqual(
1019
"# bzr knit index 8\n"
1021
"revid fulltext 0 84 :",
1024
def test_create_mode_700(self):
1025
trans = get_transport('.')
1026
if not trans._can_roundtrip_unix_modebits():
1027
# Can't roundtrip, so no need to run this test
1029
knit = KnitVersionedFile('dir/test', trans, access_mode='w',
1030
factory=None, create=True,
1031
create_parent_dir=True,
1035
knit.add_lines('revid', [], ['a\n'])
1036
self.assertTransportMode(trans, 'dir', 0700)
1037
self.assertTransportMode(trans, 'dir/test.knit', 0600)
1038
self.assertTransportMode(trans, 'dir/test.kndx', 0600)
1040
def test_create_mode_770(self):
1041
trans = get_transport('.')
1042
if not trans._can_roundtrip_unix_modebits():
1043
# Can't roundtrip, so no need to run this test
1045
knit = KnitVersionedFile('dir/test', trans, access_mode='w',
1046
factory=None, create=True,
1047
create_parent_dir=True,
1051
knit.add_lines('revid', [], ['a\n'])
1052
self.assertTransportMode(trans, 'dir', 0770)
1053
self.assertTransportMode(trans, 'dir/test.knit', 0660)
1054
self.assertTransportMode(trans, 'dir/test.kndx', 0660)
1056
def test_create_mode_777(self):
1057
trans = get_transport('.')
1058
if not trans._can_roundtrip_unix_modebits():
1059
# Can't roundtrip, so no need to run this test
1061
knit = KnitVersionedFile('dir/test', trans, access_mode='w',
1062
factory=None, create=True,
1063
create_parent_dir=True,
1067
knit.add_lines('revid', [], ['a\n'])
1068
self.assertTransportMode(trans, 'dir', 0777)
1069
self.assertTransportMode(trans, 'dir/test.knit', 0666)
1070
self.assertTransportMode(trans, 'dir/test.kndx', 0666)
1072
def test_plan_merge(self):
1073
my_knit = self.make_test_knit(annotate=True)
1074
my_knit.add_lines('text1', [], split_lines(TEXT_1))
1075
my_knit.add_lines('text1a', ['text1'], split_lines(TEXT_1A))
1076
my_knit.add_lines('text1b', ['text1'], split_lines(TEXT_1B))
1077
plan = list(my_knit.plan_merge('text1a', 'text1b'))
1078
for plan_line, expected_line in zip(plan, AB_MERGE):
1079
self.assertEqual(plan_line, expected_line)
1091
Banana cup cake recipe
1097
- self-raising flour
1101
Banana cup cake recipe
1103
- bananas (do not use plantains!!!)
1110
Banana cup cake recipe
1113
- self-raising flour
1126
AB_MERGE_TEXT="""unchanged|Banana cup cake recipe
1131
new-b|- bananas (do not use plantains!!!)
1132
unchanged|- broken tea cups
1133
new-a|- self-raising flour
1136
AB_MERGE=[tuple(l.split('|')) for l in AB_MERGE_TEXT.splitlines(True)]
1139
def line_delta(from_lines, to_lines):
1140
"""Generate line-based delta from one text to another"""
1141
s = difflib.SequenceMatcher(None, from_lines, to_lines)
1142
for op in s.get_opcodes():
1143
if op[0] == 'equal':
1145
yield '%d,%d,%d\n' % (op[1], op[2], op[4]-op[3])
1146
for i in range(op[3], op[4]):
1150
def apply_line_delta(basis_lines, delta_lines):
1151
"""Apply a line-based perfect diff
1153
basis_lines -- text to apply the patch to
1154
delta_lines -- diff instructions and content
1156
out = basis_lines[:]
1159
while i < len(delta_lines):
1161
a, b, c = map(long, l.split(','))
1163
out[offset+a:offset+b] = delta_lines[i:i+c]
1165
offset = offset + (b - a) + c
1169
class TestWeaveToKnit(KnitTests):
1171
def test_weave_to_knit_matches(self):
1172
# check that the WeaveToKnit is_compatible function
1173
# registers True for a Weave to a Knit.
1175
k = self.make_test_knit()
1176
self.failUnless(WeaveToKnit.is_compatible(w, k))
1177
self.failIf(WeaveToKnit.is_compatible(k, w))
1178
self.failIf(WeaveToKnit.is_compatible(w, w))
1179
self.failIf(WeaveToKnit.is_compatible(k, k))
1182
class TestKnitCaching(KnitTests):
1184
def create_knit(self, cache_add=False):
1185
k = self.make_test_knit(True)
1189
k.add_lines('text-1', [], split_lines(TEXT_1))
1190
k.add_lines('text-2', [], split_lines(TEXT_2))
1193
def test_no_caching(self):
1194
k = self.create_knit()
1195
# Nothing should be cached without setting 'enable_cache'
1196
self.assertEqual({}, k._data._cache)
1198
def test_cache_add_and_clear(self):
1199
k = self.create_knit(True)
1201
self.assertEqual(['text-1', 'text-2'], sorted(k._data._cache.keys()))
1204
self.assertEqual({}, k._data._cache)
1206
def test_cache_data_read_raw(self):
1207
k = self.create_knit()
1209
# Now cache and read
1212
def read_one_raw(version):
1213
pos_map = k._get_components_positions([version])
1214
method, pos, size, next = pos_map[version]
1215
lst = list(k._data.read_records_iter_raw([(version, pos, size)]))
1216
self.assertEqual(1, len(lst))
1219
val = read_one_raw('text-1')
1220
self.assertEqual({'text-1':val[1]}, k._data._cache)
1223
# After clear, new reads are not cached
1224
self.assertEqual({}, k._data._cache)
1226
val2 = read_one_raw('text-1')
1227
self.assertEqual(val, val2)
1228
self.assertEqual({}, k._data._cache)
1230
def test_cache_data_read(self):
1231
k = self.create_knit()
1233
def read_one(version):
1234
pos_map = k._get_components_positions([version])
1235
method, pos, size, next = pos_map[version]
1236
lst = list(k._data.read_records_iter([(version, pos, size)]))
1237
self.assertEqual(1, len(lst))
1240
# Now cache and read
1243
val = read_one('text-2')
1244
self.assertEqual(['text-2'], k._data._cache.keys())
1245
self.assertEqual('text-2', val[0])
1246
content, digest = k._data._parse_record('text-2',
1247
k._data._cache['text-2'])
1248
self.assertEqual(content, val[1])
1249
self.assertEqual(digest, val[2])
1252
self.assertEqual({}, k._data._cache)
1254
val2 = read_one('text-2')
1255
self.assertEqual(val, val2)
1256
self.assertEqual({}, k._data._cache)
1258
def test_cache_read(self):
1259
k = self.create_knit()
1262
text = k.get_text('text-1')
1263
self.assertEqual(TEXT_1, text)
1264
self.assertEqual(['text-1'], k._data._cache.keys())
1267
self.assertEqual({}, k._data._cache)
1269
text = k.get_text('text-1')
1270
self.assertEqual(TEXT_1, text)
1271
self.assertEqual({}, k._data._cache)
1274
class TestKnitIndex(KnitTests):
1276
def test_add_versions_dictionary_compresses(self):
1277
"""Adding versions to the index should update the lookup dict"""
1278
knit = self.make_test_knit()
1280
idx.add_version('a-1', ['fulltext'], 0, 0, [])
1281
self.check_file_contents('test.kndx',
1282
'# bzr knit index 8\n'
1284
'a-1 fulltext 0 0 :'
1286
idx.add_versions([('a-2', ['fulltext'], 0, 0, ['a-1']),
1287
('a-3', ['fulltext'], 0, 0, ['a-2']),
1289
self.check_file_contents('test.kndx',
1290
'# bzr knit index 8\n'
1292
'a-1 fulltext 0 0 :\n'
1293
'a-2 fulltext 0 0 0 :\n'
1294
'a-3 fulltext 0 0 1 :'
1296
self.assertEqual(['a-1', 'a-2', 'a-3'], idx._history)
1297
self.assertEqual({'a-1':('a-1', ['fulltext'], 0, 0, [], 0),
1298
'a-2':('a-2', ['fulltext'], 0, 0, ['a-1'], 1),
1299
'a-3':('a-3', ['fulltext'], 0, 0, ['a-2'], 2),
1302
def test_add_versions_fails_clean(self):
1303
"""If add_versions fails in the middle, it restores a pristine state.
1305
Any modifications that are made to the index are reset if all versions
1308
# This cheats a little bit by passing in a generator which will
1309
# raise an exception before the processing finishes
1310
# Other possibilities would be to have an version with the wrong number
1311
# of entries, or to make the backing transport unable to write any
1314
knit = self.make_test_knit()
1316
idx.add_version('a-1', ['fulltext'], 0, 0, [])
1318
class StopEarly(Exception):
1321
def generate_failure():
1322
"""Add some entries and then raise an exception"""
1323
yield ('a-2', ['fulltext'], 0, 0, ['a-1'])
1324
yield ('a-3', ['fulltext'], 0, 0, ['a-2'])
1327
# Assert the pre-condition
1328
self.assertEqual(['a-1'], idx._history)
1329
self.assertEqual({'a-1':('a-1', ['fulltext'], 0, 0, [], 0)}, idx._cache)
1331
self.assertRaises(StopEarly, idx.add_versions, generate_failure())
1333
# And it shouldn't be modified
1334
self.assertEqual(['a-1'], idx._history)
1335
self.assertEqual({'a-1':('a-1', ['fulltext'], 0, 0, [], 0)}, idx._cache)
1337
def test_knit_index_ignores_empty_files(self):
1338
# There was a race condition in older bzr, where a ^C at the right time
1339
# could leave an empty .kndx file, which bzr would later claim was a
1340
# corrupted file since the header was not present. In reality, the file
1341
# just wasn't created, so it should be ignored.
1342
t = get_transport('.')
1343
t.put_bytes('test.kndx', '')
1345
knit = self.make_test_knit()
1347
def test_knit_index_checks_header(self):
1348
t = get_transport('.')
1349
t.put_bytes('test.kndx', '# not really a knit header\n\n')
1351
self.assertRaises(KnitHeaderError, self.make_test_knit)