/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
2052.3.2 by John Arbash Meinel
Change Copyright .. by Canonical to Copyright ... Canonical
1
# Copyright (C) 2005 Canonical Ltd
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
2
#
3
# Authors:
4
#   Johan Rydberg <jrydberg@gnu.org>
5
#
6
# This program is free software; you can redistribute it and/or modify
7
# it under the terms of the GNU General Public License as published by
8
# the Free Software Foundation; either version 2 of the License, or
9
# (at your option) any later version.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
10
#
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
11
# This program is distributed in the hope that it will be useful,
12
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
# GNU General Public License for more details.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
15
#
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
16
# You should have received a copy of the GNU General Public License
17
# along with this program; if not, write to the Free Software
18
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
20
1704.2.15 by Martin Pool
Remove TODO about knit testing printed from test suite
21
# TODO: might be nice to create a versionedfile with some type of corruption
22
# considered typical and check that it can be detected/corrected.
23
1664.2.9 by Aaron Bentley
Ported weave merge test to versionedfile
24
from StringIO import StringIO
25
1563.2.6 by Robert Collins
Start check tests for knits (pending), and remove dead code.
26
import bzrlib
2039.1.1 by Aaron Bentley
Clean up progress properly when interrupted during fetch (#54000)
27
from bzrlib import (
28
    errors,
29
    progress,
30
    )
1563.2.11 by Robert Collins
Consolidate reweave and join as we have no separate usage, make reweave tests apply to all versionedfile implementations and deprecate the old reweave apis.
31
from bzrlib.errors import (
32
                           RevisionNotPresent, 
33
                           RevisionAlreadyPresent,
34
                           WeaveParentMismatch
35
                           )
1563.2.6 by Robert Collins
Start check tests for knits (pending), and remove dead code.
36
from bzrlib.knit import KnitVersionedFile, \
37
     KnitAnnotateFactory
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
38
from bzrlib.tests import TestCaseWithTransport
1666.1.1 by Robert Collins
Add trivial http-using test for versioned files.
39
from bzrlib.tests.HTTPTestUtil import TestCaseWithWebserver
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
40
from bzrlib.trace import mutter
1563.2.16 by Robert Collins
Change WeaveStore into VersionedFileStore and make its versoined file class parameterisable.
41
from bzrlib.transport import get_transport
1563.2.13 by Robert Collins
InterVersionedFile implemented.
42
from bzrlib.transport.memory import MemoryTransport
1684.3.1 by Robert Collins
Fix versioned file joins with empty targets.
43
from bzrlib.tsort import topo_sort
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
44
import bzrlib.versionedfile as versionedfile
1563.2.9 by Robert Collins
Update versionedfile api tests to ensure that data is available after every operation.
45
from bzrlib.weave import WeaveFile
1664.2.9 by Aaron Bentley
Ported weave merge test to versionedfile
46
from bzrlib.weavefile import read_weave, write_weave
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
47
48
49
class VersionedFileTestMixIn(object):
50
    """A mixin test class for testing VersionedFiles.
51
52
    This is not an adaptor-style test at this point because
53
    theres no dynamic substitution of versioned file implementations,
54
    they are strictly controlled by their owning repositories.
55
    """
56
57
    def test_add(self):
58
        f = self.get_file()
59
        f.add_lines('r0', [], ['a\n', 'b\n'])
60
        f.add_lines('r1', ['r0'], ['b\n', 'c\n'])
1563.2.9 by Robert Collins
Update versionedfile api tests to ensure that data is available after every operation.
61
        def verify_file(f):
62
            versions = f.versions()
63
            self.assertTrue('r0' in versions)
64
            self.assertTrue('r1' in versions)
65
            self.assertEquals(f.get_lines('r0'), ['a\n', 'b\n'])
66
            self.assertEquals(f.get_text('r0'), 'a\nb\n')
67
            self.assertEquals(f.get_lines('r1'), ['b\n', 'c\n'])
1563.2.18 by Robert Collins
get knit repositories really using knits for text storage.
68
            self.assertEqual(2, len(f))
69
            self.assertEqual(2, f.num_versions())
1563.2.9 by Robert Collins
Update versionedfile api tests to ensure that data is available after every operation.
70
    
71
            self.assertRaises(RevisionNotPresent,
72
                f.add_lines, 'r2', ['foo'], [])
73
            self.assertRaises(RevisionAlreadyPresent,
74
                f.add_lines, 'r1', [], [])
75
        verify_file(f)
1666.1.6 by Robert Collins
Make knit the default format.
76
        # this checks that reopen with create=True does not break anything.
77
        f = self.reopen_file(create=True)
1563.2.9 by Robert Collins
Update versionedfile api tests to ensure that data is available after every operation.
78
        verify_file(f)
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
79
1596.2.32 by Robert Collins
Reduce re-extraction of texts during weave to knit joins by providing a memoisation facility.
80
    def test_adds_with_parent_texts(self):
81
        f = self.get_file()
82
        parent_texts = {}
83
        parent_texts['r0'] = f.add_lines('r0', [], ['a\n', 'b\n'])
84
        try:
85
            parent_texts['r1'] = f.add_lines_with_ghosts('r1',
86
                                                         ['r0', 'ghost'], 
87
                                                         ['b\n', 'c\n'],
88
                                                         parent_texts=parent_texts)
89
        except NotImplementedError:
90
            # if the format doesn't support ghosts, just add normally.
91
            parent_texts['r1'] = f.add_lines('r1',
92
                                             ['r0'], 
93
                                             ['b\n', 'c\n'],
94
                                             parent_texts=parent_texts)
95
        f.add_lines('r2', ['r1'], ['c\n', 'd\n'], parent_texts=parent_texts)
96
        self.assertNotEqual(None, parent_texts['r0'])
97
        self.assertNotEqual(None, parent_texts['r1'])
98
        def verify_file(f):
99
            versions = f.versions()
100
            self.assertTrue('r0' in versions)
101
            self.assertTrue('r1' in versions)
102
            self.assertTrue('r2' in versions)
103
            self.assertEquals(f.get_lines('r0'), ['a\n', 'b\n'])
104
            self.assertEquals(f.get_lines('r1'), ['b\n', 'c\n'])
105
            self.assertEquals(f.get_lines('r2'), ['c\n', 'd\n'])
106
            self.assertEqual(3, f.num_versions())
107
            origins = f.annotate('r1')
108
            self.assertEquals(origins[0][0], 'r0')
109
            self.assertEquals(origins[1][0], 'r1')
110
            origins = f.annotate('r2')
111
            self.assertEquals(origins[0][0], 'r1')
112
            self.assertEquals(origins[1][0], 'r2')
113
114
        verify_file(f)
115
        f = self.reopen_file()
116
        verify_file(f)
117
1666.1.6 by Robert Collins
Make knit the default format.
118
    def test_add_unicode_content(self):
119
        # unicode content is not permitted in versioned files. 
120
        # versioned files version sequences of bytes only.
121
        vf = self.get_file()
122
        self.assertRaises(errors.BzrBadParameterUnicode,
123
            vf.add_lines, 'a', [], ['a\n', u'b\n', 'c\n'])
124
        self.assertRaises(
125
            (errors.BzrBadParameterUnicode, NotImplementedError),
126
            vf.add_lines_with_ghosts, 'a', [], ['a\n', u'b\n', 'c\n'])
127
128
    def test_inline_newline_throws(self):
129
        # \r characters are not permitted in lines being added
130
        vf = self.get_file()
131
        self.assertRaises(errors.BzrBadParameterContainsNewline, 
132
            vf.add_lines, 'a', [], ['a\n\n'])
133
        self.assertRaises(
134
            (errors.BzrBadParameterContainsNewline, NotImplementedError),
135
            vf.add_lines_with_ghosts, 'a', [], ['a\n\n'])
136
        # but inline CR's are allowed
137
        vf.add_lines('a', [], ['a\r\n'])
138
        try:
139
            vf.add_lines_with_ghosts('b', [], ['a\r\n'])
140
        except NotImplementedError:
141
            pass
142
2229.2.1 by Aaron Bentley
Reject reserved ids in versiondfile, tree, branch and repository
143
    def test_add_reserved(self):
144
        vf = self.get_file()
145
        self.assertRaises(errors.ReservedId,
146
            vf.add_lines, 'a:', [], ['a\n', 'b\n', 'c\n'])
147
148
        self.assertRaises(errors.ReservedId,
149
            vf.add_delta, 'a:', [], None, 'sha1', False, ((0, 0, 0, []),))
150
151
    def test_get_reserved(self):
152
        vf = self.get_file()
153
        self.assertRaises(errors.ReservedId, vf.get_delta, 'b:')
154
        self.assertRaises(errors.ReservedId, vf.get_texts, ['b:'])
155
        self.assertRaises(errors.ReservedId, vf.get_lines, 'b:')
156
        self.assertRaises(errors.ReservedId, vf.get_text, 'b:')
157
1596.2.37 by Robert Collins
Switch to delta based content copying in the generic versioned file copier.
158
    def test_get_delta(self):
1596.2.36 by Robert Collins
add a get_delta api to versioned_file.
159
        f = self.get_file()
1596.2.38 by Robert Collins
rollback from using deltas to using fulltexts - deltas need more work to be ready.
160
        sha1s = self._setup_for_deltas(f)
161
        expected_delta = (None, '6bfa09d82ce3e898ad4641ae13dd4fdb9cf0d76b', False, 
162
                          [(0, 0, 1, [('base', 'line\n')])])
163
        self.assertEqual(expected_delta, f.get_delta('base'))
164
        next_parent = 'base'
165
        text_name = 'chain1-'
166
        for depth in range(26):
167
            new_version = text_name + '%s' % depth
168
            expected_delta = (next_parent, sha1s[depth], 
169
                              False,
170
                              [(depth + 1, depth + 1, 1, [(new_version, 'line\n')])])
171
            self.assertEqual(expected_delta, f.get_delta(new_version))
172
            next_parent = new_version
173
        next_parent = 'base'
174
        text_name = 'chain2-'
175
        for depth in range(26):
176
            new_version = text_name + '%s' % depth
177
            expected_delta = (next_parent, sha1s[depth], False,
178
                              [(depth + 1, depth + 1, 1, [(new_version, 'line\n')])])
179
            self.assertEqual(expected_delta, f.get_delta(new_version))
180
            next_parent = new_version
181
        # smoke test for eol support
182
        expected_delta = ('base', '264f39cab871e4cfd65b3a002f7255888bb5ed97', True, [])
183
        self.assertEqual(['line'], f.get_lines('noeol'))
184
        self.assertEqual(expected_delta, f.get_delta('noeol'))
185
186
    def test_get_deltas(self):
187
        f = self.get_file()
188
        sha1s = self._setup_for_deltas(f)
189
        deltas = f.get_deltas(f.versions())
190
        expected_delta = (None, '6bfa09d82ce3e898ad4641ae13dd4fdb9cf0d76b', False, 
191
                          [(0, 0, 1, [('base', 'line\n')])])
192
        self.assertEqual(expected_delta, deltas['base'])
193
        next_parent = 'base'
194
        text_name = 'chain1-'
195
        for depth in range(26):
196
            new_version = text_name + '%s' % depth
197
            expected_delta = (next_parent, sha1s[depth], 
198
                              False,
199
                              [(depth + 1, depth + 1, 1, [(new_version, 'line\n')])])
200
            self.assertEqual(expected_delta, deltas[new_version])
201
            next_parent = new_version
202
        next_parent = 'base'
203
        text_name = 'chain2-'
204
        for depth in range(26):
205
            new_version = text_name + '%s' % depth
206
            expected_delta = (next_parent, sha1s[depth], False,
207
                              [(depth + 1, depth + 1, 1, [(new_version, 'line\n')])])
208
            self.assertEqual(expected_delta, deltas[new_version])
209
            next_parent = new_version
210
        # smoke tests for eol support
211
        expected_delta = ('base', '264f39cab871e4cfd65b3a002f7255888bb5ed97', True, [])
212
        self.assertEqual(['line'], f.get_lines('noeol'))
213
        self.assertEqual(expected_delta, deltas['noeol'])
214
        # smoke tests for eol support - two noeol in a row same content
215
        expected_deltas = (('noeol', '3ad7ee82dbd8f29ecba073f96e43e414b3f70a4d', True, 
216
                          [(0, 1, 2, [(u'noeolsecond', 'line\n'), (u'noeolsecond', 'line\n')])]),
217
                          ('noeol', '3ad7ee82dbd8f29ecba073f96e43e414b3f70a4d', True, 
218
                           [(0, 0, 1, [('noeolsecond', 'line\n')]), (1, 1, 0, [])]))
219
        self.assertEqual(['line\n', 'line'], f.get_lines('noeolsecond'))
220
        self.assertTrue(deltas['noeolsecond'] in expected_deltas)
221
        # two no-eol in a row, different content
222
        expected_delta = ('noeolsecond', '8bb553a84e019ef1149db082d65f3133b195223b', True, 
223
                          [(1, 2, 1, [(u'noeolnotshared', 'phone\n')])])
224
        self.assertEqual(['line\n', 'phone'], f.get_lines('noeolnotshared'))
225
        self.assertEqual(expected_delta, deltas['noeolnotshared'])
226
        # eol folling a no-eol with content change
227
        expected_delta = ('noeol', 'a61f6fb6cfc4596e8d88c34a308d1e724caf8977', False, 
228
                          [(0, 1, 1, [(u'eol', 'phone\n')])])
229
        self.assertEqual(['phone\n'], f.get_lines('eol'))
230
        self.assertEqual(expected_delta, deltas['eol'])
231
        # eol folling a no-eol with content change
232
        expected_delta = ('noeol', '6bfa09d82ce3e898ad4641ae13dd4fdb9cf0d76b', False, 
233
                          [(0, 1, 1, [(u'eolline', 'line\n')])])
234
        self.assertEqual(['line\n'], f.get_lines('eolline'))
235
        self.assertEqual(expected_delta, deltas['eolline'])
236
        # eol with no parents
237
        expected_delta = (None, '264f39cab871e4cfd65b3a002f7255888bb5ed97', True, 
238
                          [(0, 0, 1, [(u'noeolbase', 'line\n')])])
239
        self.assertEqual(['line'], f.get_lines('noeolbase'))
240
        self.assertEqual(expected_delta, deltas['noeolbase'])
241
        # eol with two parents, in inverse insertion order
242
        expected_deltas = (('noeolbase', '264f39cab871e4cfd65b3a002f7255888bb5ed97', True,
243
                            [(0, 1, 1, [(u'eolbeforefirstparent', 'line\n')])]),
244
                           ('noeolbase', '264f39cab871e4cfd65b3a002f7255888bb5ed97', True,
245
                            [(0, 1, 1, [(u'eolbeforefirstparent', 'line\n')])]))
246
        self.assertEqual(['line'], f.get_lines('eolbeforefirstparent'))
247
        #self.assertTrue(deltas['eolbeforefirstparent'] in expected_deltas)
248
249
    def _setup_for_deltas(self, f):
1596.2.36 by Robert Collins
add a get_delta api to versioned_file.
250
        self.assertRaises(errors.RevisionNotPresent, f.get_delta, 'base')
251
        # add texts that should trip the knit maximum delta chain threshold
252
        # as well as doing parallel chains of data in knits.
253
        # this is done by two chains of 25 insertions
254
        f.add_lines('base', [], ['line\n'])
1596.2.38 by Robert Collins
rollback from using deltas to using fulltexts - deltas need more work to be ready.
255
        f.add_lines('noeol', ['base'], ['line'])
256
        # detailed eol tests:
257
        # shared last line with parent no-eol
258
        f.add_lines('noeolsecond', ['noeol'], ['line\n', 'line'])
259
        # differing last line with parent, both no-eol
260
        f.add_lines('noeolnotshared', ['noeolsecond'], ['line\n', 'phone'])
261
        # add eol following a noneol parent, change content
262
        f.add_lines('eol', ['noeol'], ['phone\n'])
263
        # add eol following a noneol parent, no change content
264
        f.add_lines('eolline', ['noeol'], ['line\n'])
265
        # noeol with no parents:
266
        f.add_lines('noeolbase', [], ['line'])
267
        # noeol preceeding its leftmost parent in the output:
268
        # this is done by making it a merge of two parents with no common
269
        # anestry: noeolbase and noeol with the 
270
        # later-inserted parent the leftmost.
271
        f.add_lines('eolbeforefirstparent', ['noeolbase', 'noeol'], ['line'])
272
        # two identical eol texts
273
        f.add_lines('noeoldup', ['noeol'], ['line'])
1596.2.36 by Robert Collins
add a get_delta api to versioned_file.
274
        next_parent = 'base'
275
        text_name = 'chain1-'
276
        text = ['line\n']
277
        sha1s = {0 :'da6d3141cb4a5e6f464bf6e0518042ddc7bfd079',
278
                 1 :'45e21ea146a81ea44a821737acdb4f9791c8abe7',
279
                 2 :'e1f11570edf3e2a070052366c582837a4fe4e9fa',
280
                 3 :'26b4b8626da827088c514b8f9bbe4ebf181edda1',
281
                 4 :'e28a5510be25ba84d31121cff00956f9970ae6f6',
282
                 5 :'d63ec0ce22e11dcf65a931b69255d3ac747a318d',
283
                 6 :'2c2888d288cb5e1d98009d822fedfe6019c6a4ea',
284
                 7 :'95c14da9cafbf828e3e74a6f016d87926ba234ab',
285
                 8 :'779e9a0b28f9f832528d4b21e17e168c67697272',
286
                 9 :'1f8ff4e5c6ff78ac106fcfe6b1e8cb8740ff9a8f',
287
                 10:'131a2ae712cf51ed62f143e3fbac3d4206c25a05',
288
                 11:'c5a9d6f520d2515e1ec401a8f8a67e6c3c89f199',
289
                 12:'31a2286267f24d8bedaa43355f8ad7129509ea85',
290
                 13:'dc2a7fe80e8ec5cae920973973a8ee28b2da5e0a',
291
                 14:'2c4b1736566b8ca6051e668de68650686a3922f2',
292
                 15:'5912e4ecd9b0c07be4d013e7e2bdcf9323276cde',
293
                 16:'b0d2e18d3559a00580f6b49804c23fea500feab3',
294
                 17:'8e1d43ad72f7562d7cb8f57ee584e20eb1a69fc7',
295
                 18:'5cf64a3459ae28efa60239e44b20312d25b253f3',
296
                 19:'1ebed371807ba5935958ad0884595126e8c4e823',
297
                 20:'2aa62a8b06fb3b3b892a3292a068ade69d5ee0d3',
298
                 21:'01edc447978004f6e4e962b417a4ae1955b6fe5d',
299
                 22:'d8d8dc49c4bf0bab401e0298bb5ad827768618bb',
300
                 23:'c21f62b1c482862983a8ffb2b0c64b3451876e3f',
301
                 24:'c0593fe795e00dff6b3c0fe857a074364d5f04fc',
302
                 25:'dd1a1cf2ba9cc225c3aff729953e6364bf1d1855',
303
                 }
304
        for depth in range(26):
305
            new_version = text_name + '%s' % depth
306
            text = text + ['line\n']
307
            f.add_lines(new_version, [next_parent], text)
308
            next_parent = new_version
309
        next_parent = 'base'
310
        text_name = 'chain2-'
311
        text = ['line\n']
312
        for depth in range(26):
313
            new_version = text_name + '%s' % depth
314
            text = text + ['line\n']
315
            f.add_lines(new_version, [next_parent], text)
316
            next_parent = new_version
1596.2.38 by Robert Collins
rollback from using deltas to using fulltexts - deltas need more work to be ready.
317
        return sha1s
1596.2.37 by Robert Collins
Switch to delta based content copying in the generic versioned file copier.
318
319
    def test_add_delta(self):
320
        # tests for the add-delta facility.
321
        # at this point, optimising for speed, we assume no checks when deltas are inserted.
322
        # this may need to be revisited.
323
        source = self.get_file('source')
324
        source.add_lines('base', [], ['line\n'])
325
        next_parent = 'base'
326
        text_name = 'chain1-'
327
        text = ['line\n']
328
        for depth in range(26):
329
            new_version = text_name + '%s' % depth
330
            text = text + ['line\n']
331
            source.add_lines(new_version, [next_parent], text)
332
            next_parent = new_version
333
        next_parent = 'base'
334
        text_name = 'chain2-'
335
        text = ['line\n']
336
        for depth in range(26):
337
            new_version = text_name + '%s' % depth
338
            text = text + ['line\n']
339
            source.add_lines(new_version, [next_parent], text)
340
            next_parent = new_version
341
        source.add_lines('noeol', ['base'], ['line'])
342
        
343
        target = self.get_file('target')
344
        for version in source.versions():
345
            parent, sha1, noeol, delta = source.get_delta(version)
346
            target.add_delta(version,
347
                             source.get_parents(version),
348
                             parent,
349
                             sha1,
350
                             noeol,
351
                             delta)
352
        self.assertRaises(RevisionAlreadyPresent,
353
                          target.add_delta, 'base', [], None, '', False, [])
354
        for version in source.versions():
355
            self.assertEqual(source.get_lines(version),
356
                             target.get_lines(version))
1596.2.36 by Robert Collins
add a get_delta api to versioned_file.
357
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
358
    def test_ancestry(self):
359
        f = self.get_file()
1563.2.29 by Robert Collins
Remove all but fetch references to repository.revision_store.
360
        self.assertEqual([], f.get_ancestry([]))
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
361
        f.add_lines('r0', [], ['a\n', 'b\n'])
362
        f.add_lines('r1', ['r0'], ['b\n', 'c\n'])
363
        f.add_lines('r2', ['r0'], ['b\n', 'c\n'])
364
        f.add_lines('r3', ['r2'], ['b\n', 'c\n'])
365
        f.add_lines('rM', ['r1', 'r2'], ['b\n', 'c\n'])
1563.2.29 by Robert Collins
Remove all but fetch references to repository.revision_store.
366
        self.assertEqual([], f.get_ancestry([]))
1563.2.35 by Robert Collins
cleanup deprecation warnings and finish conversion so the inventory is knit based too.
367
        versions = f.get_ancestry(['rM'])
368
        # there are some possibilities:
369
        # r0 r1 r2 rM r3
370
        # r0 r1 r2 r3 rM
371
        # etc
372
        # so we check indexes
373
        r0 = versions.index('r0')
374
        r1 = versions.index('r1')
375
        r2 = versions.index('r2')
376
        self.assertFalse('r3' in versions)
377
        rM = versions.index('rM')
378
        self.assertTrue(r0 < r1)
379
        self.assertTrue(r0 < r2)
380
        self.assertTrue(r1 < rM)
381
        self.assertTrue(r2 < rM)
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
382
383
        self.assertRaises(RevisionNotPresent,
384
            f.get_ancestry, ['rM', 'rX'])
1594.2.21 by Robert Collins
Teach versioned files to prevent mutation after finishing.
385
386
    def test_mutate_after_finish(self):
387
        f = self.get_file()
388
        f.transaction_finished()
1596.2.37 by Robert Collins
Switch to delta based content copying in the generic versioned file copier.
389
        self.assertRaises(errors.OutSideTransaction, f.add_delta, '', [], '', '', False, [])
1594.2.21 by Robert Collins
Teach versioned files to prevent mutation after finishing.
390
        self.assertRaises(errors.OutSideTransaction, f.add_lines, '', [], [])
391
        self.assertRaises(errors.OutSideTransaction, f.add_lines_with_ghosts, '', [], [])
392
        self.assertRaises(errors.OutSideTransaction, f.fix_parents, '', [])
393
        self.assertRaises(errors.OutSideTransaction, f.join, '')
1594.2.24 by Robert Collins
Make use of the transaction finalisation warning support to implement in-knit caching.
394
        self.assertRaises(errors.OutSideTransaction, f.clone_text, 'base', 'bar', ['foo'])
1563.2.7 by Robert Collins
add versioned file clear_cache entry.
395
        
396
    def test_clear_cache(self):
397
        f = self.get_file()
398
        # on a new file it should not error
399
        f.clear_cache()
400
        # and after adding content, doing a clear_cache and a get should work.
401
        f.add_lines('0', [], ['a'])
402
        f.clear_cache()
403
        self.assertEqual(['a'], f.get_lines('0'))
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
404
405
    def test_clone_text(self):
406
        f = self.get_file()
407
        f.add_lines('r0', [], ['a\n', 'b\n'])
1563.2.5 by Robert Collins
Remove unused transaction references from knit.py and the versionedfile interface.
408
        f.clone_text('r1', 'r0', ['r0'])
1563.2.9 by Robert Collins
Update versionedfile api tests to ensure that data is available after every operation.
409
        def verify_file(f):
410
            self.assertEquals(f.get_lines('r1'), f.get_lines('r0'))
411
            self.assertEquals(f.get_lines('r1'), ['a\n', 'b\n'])
412
            self.assertEquals(f.get_parents('r1'), ['r0'])
413
    
414
            self.assertRaises(RevisionNotPresent,
415
                f.clone_text, 'r2', 'rX', [])
416
            self.assertRaises(RevisionAlreadyPresent,
417
                f.clone_text, 'r1', 'r0', [])
418
        verify_file(f)
419
        verify_file(self.reopen_file())
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
420
1563.2.13 by Robert Collins
InterVersionedFile implemented.
421
    def test_create_empty(self):
422
        f = self.get_file()
423
        f.add_lines('0', [], ['a\n'])
424
        new_f = f.create_empty('t', MemoryTransport())
425
        # smoke test, specific types should check it is honoured correctly for
426
        # non type attributes
427
        self.assertEqual([], new_f.versions())
428
        self.assertTrue(isinstance(new_f, f.__class__))
429
1563.2.15 by Robert Collins
remove the weavestore assumptions about the number and nature of files it manages.
430
    def test_copy_to(self):
431
        f = self.get_file()
432
        f.add_lines('0', [], ['a\n'])
433
        t = MemoryTransport()
434
        f.copy_to('foo', t)
435
        for suffix in f.__class__.get_suffixes():
436
            self.assertTrue(t.has('foo' + suffix))
437
438
    def test_get_suffixes(self):
439
        f = self.get_file()
440
        # should be the same
441
        self.assertEqual(f.__class__.get_suffixes(), f.__class__.get_suffixes())
442
        # and should be a list
443
        self.assertTrue(isinstance(f.__class__.get_suffixes(), list))
444
1684.3.1 by Robert Collins
Fix versioned file joins with empty targets.
445
    def build_graph(self, file, graph):
446
        for node in topo_sort(graph.items()):
447
            file.add_lines(node, graph[node], [])
448
1563.2.13 by Robert Collins
InterVersionedFile implemented.
449
    def test_get_graph(self):
450
        f = self.get_file()
1684.3.1 by Robert Collins
Fix versioned file joins with empty targets.
451
        graph = {
452
            'v1': [],
453
            'v2': ['v1'],
454
            'v3': ['v2']}
455
        self.build_graph(f, graph)
456
        self.assertEqual(graph, f.get_graph())
457
    
458
    def test_get_graph_partial(self):
459
        f = self.get_file()
460
        complex_graph = {}
461
        simple_a = {
462
            'c': [],
463
            'b': ['c'],
464
            'a': ['b'],
465
            }
466
        complex_graph.update(simple_a)
467
        simple_b = {
468
            'c': [],
469
            'b': ['c'],
470
            }
471
        complex_graph.update(simple_b)
472
        simple_gam = {
473
            'c': [],
474
            'oo': [],
475
            'bar': ['oo', 'c'],
476
            'gam': ['bar'],
477
            }
478
        complex_graph.update(simple_gam)
479
        simple_b_gam = {}
480
        simple_b_gam.update(simple_gam)
481
        simple_b_gam.update(simple_b)
482
        self.build_graph(f, complex_graph)
483
        self.assertEqual(simple_a, f.get_graph(['a']))
484
        self.assertEqual(simple_b, f.get_graph(['b']))
485
        self.assertEqual(simple_gam, f.get_graph(['gam']))
486
        self.assertEqual(simple_b_gam, f.get_graph(['b', 'gam']))
1563.2.13 by Robert Collins
InterVersionedFile implemented.
487
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
488
    def test_get_parents(self):
489
        f = self.get_file()
490
        f.add_lines('r0', [], ['a\n', 'b\n'])
491
        f.add_lines('r1', [], ['a\n', 'b\n'])
492
        f.add_lines('r2', [], ['a\n', 'b\n'])
493
        f.add_lines('r3', [], ['a\n', 'b\n'])
494
        f.add_lines('m', ['r0', 'r1', 'r2', 'r3'], ['a\n', 'b\n'])
495
        self.assertEquals(f.get_parents('m'), ['r0', 'r1', 'r2', 'r3'])
496
497
        self.assertRaises(RevisionNotPresent,
498
            f.get_parents, 'y')
499
500
    def test_annotate(self):
501
        f = self.get_file()
502
        f.add_lines('r0', [], ['a\n', 'b\n'])
503
        f.add_lines('r1', ['r0'], ['c\n', 'b\n'])
504
        origins = f.annotate('r1')
505
        self.assertEquals(origins[0][0], 'r1')
506
        self.assertEquals(origins[1][0], 'r0')
507
508
        self.assertRaises(RevisionNotPresent,
509
            f.annotate, 'foo')
510
511
    def test_walk(self):
1563.2.35 by Robert Collins
cleanup deprecation warnings and finish conversion so the inventory is knit based too.
512
        # tests that walk returns all the inclusions for the requested
513
        # revisions as well as the revisions changes themselves.
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
514
        f = self.get_file('1')
515
        f.add_lines('r0', [], ['a\n', 'b\n'])
516
        f.add_lines('r1', ['r0'], ['c\n', 'b\n'])
517
        f.add_lines('rX', ['r1'], ['d\n', 'b\n'])
518
        f.add_lines('rY', ['r1'], ['c\n', 'e\n'])
519
520
        lines = {}
521
        for lineno, insert, dset, text in f.walk(['rX', 'rY']):
522
            lines[text] = (insert, dset)
523
524
        self.assertTrue(lines['a\n'], ('r0', set(['r1'])))
525
        self.assertTrue(lines['b\n'], ('r0', set(['rY'])))
526
        self.assertTrue(lines['c\n'], ('r1', set(['rX'])))
527
        self.assertTrue(lines['d\n'], ('rX', set([])))
528
        self.assertTrue(lines['e\n'], ('rY', set([])))
529
1563.2.6 by Robert Collins
Start check tests for knits (pending), and remove dead code.
530
    def test_detection(self):
531
        # Test weaves detect corruption.
532
        #
533
        # Weaves contain a checksum of their texts.
534
        # When a text is extracted, this checksum should be
535
        # verified.
536
537
        w = self.get_file_corrupted_text()
538
539
        self.assertEqual('hello\n', w.get_text('v1'))
540
        self.assertRaises(errors.WeaveInvalidChecksum, w.get_text, 'v2')
541
        self.assertRaises(errors.WeaveInvalidChecksum, w.get_lines, 'v2')
542
        self.assertRaises(errors.WeaveInvalidChecksum, w.check)
543
544
        w = self.get_file_corrupted_checksum()
545
546
        self.assertEqual('hello\n', w.get_text('v1'))
547
        self.assertRaises(errors.WeaveInvalidChecksum, w.get_text, 'v2')
548
        self.assertRaises(errors.WeaveInvalidChecksum, w.get_lines, 'v2')
549
        self.assertRaises(errors.WeaveInvalidChecksum, w.check)
550
551
    def get_file_corrupted_text(self):
552
        """Return a versioned file with corrupt text but valid metadata."""
553
        raise NotImplementedError(self.get_file_corrupted_text)
554
1563.2.9 by Robert Collins
Update versionedfile api tests to ensure that data is available after every operation.
555
    def reopen_file(self, name='foo'):
556
        """Open the versioned file from disk again."""
557
        raise NotImplementedError(self.reopen_file)
558
1594.2.6 by Robert Collins
Introduce a api specifically for looking at lines in some versions of the inventory, for fileid_involved.
559
    def test_iter_lines_added_or_present_in_versions(self):
560
        # test that we get at least an equalset of the lines added by
561
        # versions in the weave 
562
        # the ordering here is to make a tree so that dumb searches have
563
        # more changes to muck up.
2039.1.1 by Aaron Bentley
Clean up progress properly when interrupted during fetch (#54000)
564
565
        class InstrumentedProgress(progress.DummyProgress):
566
567
            def __init__(self):
568
569
                progress.DummyProgress.__init__(self)
570
                self.updates = []
571
572
            def update(self, msg=None, current=None, total=None):
573
                self.updates.append((msg, current, total))
574
1594.2.6 by Robert Collins
Introduce a api specifically for looking at lines in some versions of the inventory, for fileid_involved.
575
        vf = self.get_file()
576
        # add a base to get included
577
        vf.add_lines('base', [], ['base\n'])
578
        # add a ancestor to be included on one side
579
        vf.add_lines('lancestor', [], ['lancestor\n'])
580
        # add a ancestor to be included on the other side
581
        vf.add_lines('rancestor', ['base'], ['rancestor\n'])
582
        # add a child of rancestor with no eofile-nl
583
        vf.add_lines('child', ['rancestor'], ['base\n', 'child\n'])
584
        # add a child of lancestor and base to join the two roots
585
        vf.add_lines('otherchild',
586
                     ['lancestor', 'base'],
587
                     ['base\n', 'lancestor\n', 'otherchild\n'])
2039.1.1 by Aaron Bentley
Clean up progress properly when interrupted during fetch (#54000)
588
        def iter_with_versions(versions, expected):
1594.2.6 by Robert Collins
Introduce a api specifically for looking at lines in some versions of the inventory, for fileid_involved.
589
            # now we need to see what lines are returned, and how often.
590
            lines = {'base\n':0,
591
                     'lancestor\n':0,
592
                     'rancestor\n':0,
593
                     'child\n':0,
594
                     'otherchild\n':0,
595
                     }
2039.1.1 by Aaron Bentley
Clean up progress properly when interrupted during fetch (#54000)
596
            progress = InstrumentedProgress()
1594.2.6 by Robert Collins
Introduce a api specifically for looking at lines in some versions of the inventory, for fileid_involved.
597
            # iterate over the lines
2039.1.1 by Aaron Bentley
Clean up progress properly when interrupted during fetch (#54000)
598
            for line in vf.iter_lines_added_or_present_in_versions(versions, 
599
                pb=progress):
1594.2.6 by Robert Collins
Introduce a api specifically for looking at lines in some versions of the inventory, for fileid_involved.
600
                lines[line] += 1
2039.1.2 by Aaron Bentley
Tweak test to avoid catching assert
601
            if []!= progress.updates: 
602
                self.assertEqual(expected, progress.updates)
1594.2.6 by Robert Collins
Introduce a api specifically for looking at lines in some versions of the inventory, for fileid_involved.
603
            return lines
2147.1.3 by John Arbash Meinel
In knit.py we were re-using a variable in 2 loops, causing bogus progress messages to be generated.
604
        lines = iter_with_versions(['child', 'otherchild'],
605
                                   [('Walking content.', 0, 2),
606
                                    ('Walking content.', 1, 2),
2039.1.1 by Aaron Bentley
Clean up progress properly when interrupted during fetch (#54000)
607
                                    ('Walking content.', 2, 2)])
1594.2.6 by Robert Collins
Introduce a api specifically for looking at lines in some versions of the inventory, for fileid_involved.
608
        # we must see child and otherchild
609
        self.assertTrue(lines['child\n'] > 0)
610
        self.assertTrue(lines['otherchild\n'] > 0)
611
        # we dont care if we got more than that.
612
        
613
        # test all lines
2147.1.3 by John Arbash Meinel
In knit.py we were re-using a variable in 2 loops, causing bogus progress messages to be generated.
614
        lines = iter_with_versions(None, [('Walking content.', 0, 5),
615
                                          ('Walking content.', 1, 5),
616
                                          ('Walking content.', 2, 5),
617
                                          ('Walking content.', 3, 5),
618
                                          ('Walking content.', 4, 5),
2039.1.1 by Aaron Bentley
Clean up progress properly when interrupted during fetch (#54000)
619
                                          ('Walking content.', 5, 5)])
1594.2.6 by Robert Collins
Introduce a api specifically for looking at lines in some versions of the inventory, for fileid_involved.
620
        # all lines must be seen at least once
621
        self.assertTrue(lines['base\n'] > 0)
622
        self.assertTrue(lines['lancestor\n'] > 0)
623
        self.assertTrue(lines['rancestor\n'] > 0)
624
        self.assertTrue(lines['child\n'] > 0)
625
        self.assertTrue(lines['otherchild\n'] > 0)
1594.2.7 by Robert Collins
Add versionedfile.fix_parents api for correcting data post hoc.
626
627
    def test_fix_parents(self):
628
        # some versioned files allow incorrect parents to be corrected after
629
        # insertion - this may not fix ancestry..
630
        # if they do not supported, they just do not implement it.
1594.2.8 by Robert Collins
add ghost aware apis to knits.
631
        # we test this as an interface test to ensure that those that *do*
632
        # implementent it get it right.
1594.2.7 by Robert Collins
Add versionedfile.fix_parents api for correcting data post hoc.
633
        vf = self.get_file()
634
        vf.add_lines('notbase', [], [])
635
        vf.add_lines('base', [], [])
636
        try:
637
            vf.fix_parents('notbase', ['base'])
638
        except NotImplementedError:
639
            return
640
        self.assertEqual(['base'], vf.get_parents('notbase'))
641
        # open again, check it stuck.
642
        vf = self.get_file()
643
        self.assertEqual(['base'], vf.get_parents('notbase'))
644
1594.2.8 by Robert Collins
add ghost aware apis to knits.
645
    def test_fix_parents_with_ghosts(self):
646
        # when fixing parents, ghosts that are listed should not be ghosts
647
        # anymore.
648
        vf = self.get_file()
649
650
        try:
651
            vf.add_lines_with_ghosts('notbase', ['base', 'stillghost'], [])
652
        except NotImplementedError:
653
            return
654
        vf.add_lines('base', [], [])
655
        vf.fix_parents('notbase', ['base', 'stillghost'])
656
        self.assertEqual(['base'], vf.get_parents('notbase'))
657
        # open again, check it stuck.
658
        vf = self.get_file()
659
        self.assertEqual(['base'], vf.get_parents('notbase'))
660
        # and check the ghosts
661
        self.assertEqual(['base', 'stillghost'],
662
                         vf.get_parents_with_ghosts('notbase'))
663
664
    def test_add_lines_with_ghosts(self):
665
        # some versioned file formats allow lines to be added with parent
666
        # information that is > than that in the format. Formats that do
667
        # not support this need to raise NotImplementedError on the
668
        # add_lines_with_ghosts api.
669
        vf = self.get_file()
670
        # add a revision with ghost parents
671
        try:
1596.2.9 by Robert Collins
Utf8 safety in knit indexes.
672
            vf.add_lines_with_ghosts(u'notbxbfse', [u'b\xbfse'], [])
1594.2.8 by Robert Collins
add ghost aware apis to knits.
673
        except NotImplementedError:
674
            # check the other ghost apis are also not implemented
675
            self.assertRaises(NotImplementedError, vf.has_ghost, 'foo')
676
            self.assertRaises(NotImplementedError, vf.get_ancestry_with_ghosts, ['foo'])
677
            self.assertRaises(NotImplementedError, vf.get_parents_with_ghosts, 'foo')
678
            self.assertRaises(NotImplementedError, vf.get_graph_with_ghosts)
679
            return
2150.2.1 by Robert Collins
Correctly decode utf8 revision ids from knits when parsing, fixes a regression where a unicode revision id is stored correctly, but then indexed by the utf8 value on the next invocation of bzr, rather than the unicode value.
680
        vf = self.reopen_file()
1594.2.8 by Robert Collins
add ghost aware apis to knits.
681
        # test key graph related apis: getncestry, _graph, get_parents
682
        # has_version
683
        # - these are ghost unaware and must not be reflect ghosts
1596.2.9 by Robert Collins
Utf8 safety in knit indexes.
684
        self.assertEqual([u'notbxbfse'], vf.get_ancestry(u'notbxbfse'))
685
        self.assertEqual([], vf.get_parents(u'notbxbfse'))
686
        self.assertEqual({u'notbxbfse':[]}, vf.get_graph())
687
        self.assertFalse(vf.has_version(u'b\xbfse'))
1594.2.8 by Robert Collins
add ghost aware apis to knits.
688
        # we have _with_ghost apis to give us ghost information.
1596.2.9 by Robert Collins
Utf8 safety in knit indexes.
689
        self.assertEqual([u'b\xbfse', u'notbxbfse'], vf.get_ancestry_with_ghosts([u'notbxbfse']))
690
        self.assertEqual([u'b\xbfse'], vf.get_parents_with_ghosts(u'notbxbfse'))
691
        self.assertEqual({u'notbxbfse':[u'b\xbfse']}, vf.get_graph_with_ghosts())
692
        self.assertTrue(vf.has_ghost(u'b\xbfse'))
1594.2.8 by Robert Collins
add ghost aware apis to knits.
693
        # if we add something that is a ghost of another, it should correct the
694
        # results of the prior apis
1596.2.9 by Robert Collins
Utf8 safety in knit indexes.
695
        vf.add_lines(u'b\xbfse', [], [])
696
        self.assertEqual([u'b\xbfse', u'notbxbfse'], vf.get_ancestry([u'notbxbfse']))
697
        self.assertEqual([u'b\xbfse'], vf.get_parents(u'notbxbfse'))
698
        self.assertEqual({u'b\xbfse':[],
699
                          u'notbxbfse':[u'b\xbfse'],
1594.2.8 by Robert Collins
add ghost aware apis to knits.
700
                          },
701
                         vf.get_graph())
1596.2.9 by Robert Collins
Utf8 safety in knit indexes.
702
        self.assertTrue(vf.has_version(u'b\xbfse'))
1594.2.8 by Robert Collins
add ghost aware apis to knits.
703
        # we have _with_ghost apis to give us ghost information.
1596.2.9 by Robert Collins
Utf8 safety in knit indexes.
704
        self.assertEqual([u'b\xbfse', u'notbxbfse'], vf.get_ancestry_with_ghosts([u'notbxbfse']))
705
        self.assertEqual([u'b\xbfse'], vf.get_parents_with_ghosts(u'notbxbfse'))
706
        self.assertEqual({u'b\xbfse':[],
707
                          u'notbxbfse':[u'b\xbfse'],
1594.2.8 by Robert Collins
add ghost aware apis to knits.
708
                          },
709
                         vf.get_graph_with_ghosts())
1596.2.9 by Robert Collins
Utf8 safety in knit indexes.
710
        self.assertFalse(vf.has_ghost(u'b\xbfse'))
1594.2.8 by Robert Collins
add ghost aware apis to knits.
711
1594.2.9 by Robert Collins
Teach Knit repositories how to handle ghosts without corrupting at all.
712
    def test_add_lines_with_ghosts_after_normal_revs(self):
713
        # some versioned file formats allow lines to be added with parent
714
        # information that is > than that in the format. Formats that do
715
        # not support this need to raise NotImplementedError on the
716
        # add_lines_with_ghosts api.
717
        vf = self.get_file()
718
        # probe for ghost support
719
        try:
720
            vf.has_ghost('hoo')
721
        except NotImplementedError:
722
            return
723
        vf.add_lines_with_ghosts('base', [], ['line\n', 'line_b\n'])
724
        vf.add_lines_with_ghosts('references_ghost',
725
                                 ['base', 'a_ghost'],
726
                                 ['line\n', 'line_b\n', 'line_c\n'])
727
        origins = vf.annotate('references_ghost')
728
        self.assertEquals(('base', 'line\n'), origins[0])
729
        self.assertEquals(('base', 'line_b\n'), origins[1])
730
        self.assertEquals(('references_ghost', 'line_c\n'), origins[2])
1594.2.23 by Robert Collins
Test versioned file storage handling of clean/dirty status for accessed versioned files.
731
732
    def test_readonly_mode(self):
733
        transport = get_transport(self.get_url('.'))
734
        factory = self.get_factory()
735
        vf = factory('id', transport, 0777, create=True, access_mode='w')
736
        vf = factory('id', transport, access_mode='r')
1596.2.37 by Robert Collins
Switch to delta based content copying in the generic versioned file copier.
737
        self.assertRaises(errors.ReadOnlyError, vf.add_delta, '', [], '', '', False, [])
1594.2.23 by Robert Collins
Test versioned file storage handling of clean/dirty status for accessed versioned files.
738
        self.assertRaises(errors.ReadOnlyError, vf.add_lines, 'base', [], [])
739
        self.assertRaises(errors.ReadOnlyError,
740
                          vf.add_lines_with_ghosts,
741
                          'base',
742
                          [],
743
                          [])
744
        self.assertRaises(errors.ReadOnlyError, vf.fix_parents, 'base', [])
745
        self.assertRaises(errors.ReadOnlyError, vf.join, 'base')
1594.2.24 by Robert Collins
Make use of the transaction finalisation warning support to implement in-knit caching.
746
        self.assertRaises(errors.ReadOnlyError, vf.clone_text, 'base', 'bar', ['foo'])
1666.1.6 by Robert Collins
Make knit the default format.
747
    
748
    def test_get_sha1(self):
749
        # check the sha1 data is available
750
        vf = self.get_file()
751
        # a simple file
752
        vf.add_lines('a', [], ['a\n'])
753
        # the same file, different metadata
754
        vf.add_lines('b', ['a'], ['a\n'])
755
        # a file differing only in last newline.
756
        vf.add_lines('c', [], ['a'])
757
        self.assertEqual(
758
            '3f786850e387550fdab836ed7e6dc881de23001b', vf.get_sha1('a'))
759
        self.assertEqual(
760
            '3f786850e387550fdab836ed7e6dc881de23001b', vf.get_sha1('b'))
761
        self.assertEqual(
762
            '86f7e437faa5a7fce15d1ddcb9eaeaea377667b8', vf.get_sha1('c'))
1594.2.9 by Robert Collins
Teach Knit repositories how to handle ghosts without corrupting at all.
763
        
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
764
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
765
class TestWeave(TestCaseWithTransport, VersionedFileTestMixIn):
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
766
767
    def get_file(self, name='foo'):
1563.2.25 by Robert Collins
Merge in upstream.
768
        return WeaveFile(name, get_transport(self.get_url('.')), create=True)
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
769
1563.2.6 by Robert Collins
Start check tests for knits (pending), and remove dead code.
770
    def get_file_corrupted_text(self):
1563.2.25 by Robert Collins
Merge in upstream.
771
        w = WeaveFile('foo', get_transport(self.get_url('.')), create=True)
1563.2.13 by Robert Collins
InterVersionedFile implemented.
772
        w.add_lines('v1', [], ['hello\n'])
773
        w.add_lines('v2', ['v1'], ['hello\n', 'there\n'])
1563.2.6 by Robert Collins
Start check tests for knits (pending), and remove dead code.
774
        
775
        # We are going to invasively corrupt the text
776
        # Make sure the internals of weave are the same
777
        self.assertEqual([('{', 0)
778
                        , 'hello\n'
779
                        , ('}', None)
780
                        , ('{', 1)
781
                        , 'there\n'
782
                        , ('}', None)
783
                        ], w._weave)
784
        
785
        self.assertEqual(['f572d396fae9206628714fb2ce00f72e94f2258f'
786
                        , '90f265c6e75f1c8f9ab76dcf85528352c5f215ef'
787
                        ], w._sha1s)
788
        w.check()
789
        
790
        # Corrupted
791
        w._weave[4] = 'There\n'
792
        return w
793
794
    def get_file_corrupted_checksum(self):
795
        w = self.get_file_corrupted_text()
796
        # Corrected
797
        w._weave[4] = 'there\n'
798
        self.assertEqual('hello\nthere\n', w.get_text('v2'))
799
        
800
        #Invalid checksum, first digit changed
801
        w._sha1s[1] =  'f0f265c6e75f1c8f9ab76dcf85528352c5f215ef'
802
        return w
803
1666.1.6 by Robert Collins
Make knit the default format.
804
    def reopen_file(self, name='foo', create=False):
805
        return WeaveFile(name, get_transport(self.get_url('.')), create=create)
1563.2.9 by Robert Collins
Update versionedfile api tests to ensure that data is available after every operation.
806
1563.2.25 by Robert Collins
Merge in upstream.
807
    def test_no_implicit_create(self):
808
        self.assertRaises(errors.NoSuchFile,
809
                          WeaveFile,
810
                          'foo',
811
                          get_transport(self.get_url('.')))
812
1594.2.23 by Robert Collins
Test versioned file storage handling of clean/dirty status for accessed versioned files.
813
    def get_factory(self):
814
        return WeaveFile
815
1563.2.1 by Robert Collins
Merge in a variation of the versionedfile api from versioned-file.
816
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
817
class TestKnit(TestCaseWithTransport, VersionedFileTestMixIn):
1563.2.4 by Robert Collins
First cut at including the knit implementation of versioned_file.
818
819
    def get_file(self, name='foo'):
1563.2.16 by Robert Collins
Change WeaveStore into VersionedFileStore and make its versoined file class parameterisable.
820
        return KnitVersionedFile(name, get_transport(self.get_url('.')),
1563.2.25 by Robert Collins
Merge in upstream.
821
                                 delta=True, create=True)
1563.2.6 by Robert Collins
Start check tests for knits (pending), and remove dead code.
822
1594.2.23 by Robert Collins
Test versioned file storage handling of clean/dirty status for accessed versioned files.
823
    def get_factory(self):
824
        return KnitVersionedFile
825
1563.2.6 by Robert Collins
Start check tests for knits (pending), and remove dead code.
826
    def get_file_corrupted_text(self):
827
        knit = self.get_file()
828
        knit.add_lines('v1', [], ['hello\n'])
829
        knit.add_lines('v2', ['v1'], ['hello\n', 'there\n'])
830
        return knit
1563.2.9 by Robert Collins
Update versionedfile api tests to ensure that data is available after every operation.
831
1666.1.6 by Robert Collins
Make knit the default format.
832
    def reopen_file(self, name='foo', create=False):
833
        return KnitVersionedFile(name, get_transport(self.get_url('.')),
834
            delta=True,
835
            create=create)
1563.2.10 by Robert Collins
Change weave store to be a versioned store, using WeaveFiles which maintain integrity without needing explicit 'put' operations.
836
837
    def test_detection(self):
1563.2.19 by Robert Collins
stub out a check for knits.
838
        knit = self.get_file()
839
        knit.check()
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
840
1563.2.25 by Robert Collins
Merge in upstream.
841
    def test_no_implicit_create(self):
842
        self.assertRaises(errors.NoSuchFile,
843
                          KnitVersionedFile,
844
                          'foo',
845
                          get_transport(self.get_url('.')))
846
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
847
848
class InterString(versionedfile.InterVersionedFile):
849
    """An inter-versionedfile optimised code path for strings.
850
851
    This is for use during testing where we use strings as versionedfiles
852
    so that none of the default regsitered interversionedfile classes will
853
    match - which lets us test the match logic.
854
    """
855
856
    @staticmethod
857
    def is_compatible(source, target):
858
        """InterString is compatible with strings-as-versionedfiles."""
859
        return isinstance(source, str) and isinstance(target, str)
860
861
862
# TODO this and the InterRepository core logic should be consolidatable
863
# if we make the registry a separate class though we still need to 
864
# test the behaviour in the active registry to catch failure-to-handle-
865
# stange-objects
866
class TestInterVersionedFile(TestCaseWithTransport):
867
868
    def test_get_default_inter_versionedfile(self):
869
        # test that the InterVersionedFile.get(a, b) probes
870
        # for a class where is_compatible(a, b) returns
871
        # true and returns a default interversionedfile otherwise.
872
        # This also tests that the default registered optimised interversionedfile
873
        # classes do not barf inappropriately when a surprising versionedfile type
874
        # is handed to them.
875
        dummy_a = "VersionedFile 1."
876
        dummy_b = "VersionedFile 2."
877
        self.assertGetsDefaultInterVersionedFile(dummy_a, dummy_b)
878
879
    def assertGetsDefaultInterVersionedFile(self, a, b):
880
        """Asserts that InterVersionedFile.get(a, b) -> the default."""
881
        inter = versionedfile.InterVersionedFile.get(a, b)
882
        self.assertEqual(versionedfile.InterVersionedFile,
883
                         inter.__class__)
884
        self.assertEqual(a, inter.source)
885
        self.assertEqual(b, inter.target)
886
887
    def test_register_inter_versionedfile_class(self):
888
        # test that a optimised code path provider - a
889
        # InterVersionedFile subclass can be registered and unregistered
890
        # and that it is correctly selected when given a versionedfile
891
        # pair that it returns true on for the is_compatible static method
892
        # check
893
        dummy_a = "VersionedFile 1."
894
        dummy_b = "VersionedFile 2."
895
        versionedfile.InterVersionedFile.register_optimiser(InterString)
896
        try:
897
            # we should get the default for something InterString returns False
898
            # to
899
            self.assertFalse(InterString.is_compatible(dummy_a, None))
900
            self.assertGetsDefaultInterVersionedFile(dummy_a, None)
901
            # and we should get an InterString for a pair it 'likes'
902
            self.assertTrue(InterString.is_compatible(dummy_a, dummy_b))
903
            inter = versionedfile.InterVersionedFile.get(dummy_a, dummy_b)
904
            self.assertEqual(InterString, inter.__class__)
905
            self.assertEqual(dummy_a, inter.source)
906
            self.assertEqual(dummy_b, inter.target)
907
        finally:
908
            versionedfile.InterVersionedFile.unregister_optimiser(InterString)
909
        # now we should get the default InterVersionedFile object again.
910
        self.assertGetsDefaultInterVersionedFile(dummy_a, dummy_b)
1666.1.1 by Robert Collins
Add trivial http-using test for versioned files.
911
912
913
class TestReadonlyHttpMixin(object):
914
915
    def test_readonly_http_works(self):
916
        # we should be able to read from http with a versioned file.
917
        vf = self.get_file()
1666.1.6 by Robert Collins
Make knit the default format.
918
        # try an empty file access
919
        readonly_vf = self.get_factory()('foo', get_transport(self.get_readonly_url('.')))
920
        self.assertEqual([], readonly_vf.versions())
921
        # now with feeling.
1666.1.1 by Robert Collins
Add trivial http-using test for versioned files.
922
        vf.add_lines('1', [], ['a\n'])
923
        vf.add_lines('2', ['1'], ['b\n', 'a\n'])
924
        readonly_vf = self.get_factory()('foo', get_transport(self.get_readonly_url('.')))
1666.1.6 by Robert Collins
Make knit the default format.
925
        self.assertEqual(['1', '2'], vf.versions())
1666.1.1 by Robert Collins
Add trivial http-using test for versioned files.
926
        for version in readonly_vf.versions():
927
            readonly_vf.get_lines(version)
928
929
930
class TestWeaveHTTP(TestCaseWithWebserver, TestReadonlyHttpMixin):
931
932
    def get_file(self):
933
        return WeaveFile('foo', get_transport(self.get_url('.')), create=True)
934
935
    def get_factory(self):
936
        return WeaveFile
937
938
939
class TestKnitHTTP(TestCaseWithWebserver, TestReadonlyHttpMixin):
940
941
    def get_file(self):
942
        return KnitVersionedFile('foo', get_transport(self.get_url('.')),
943
                                 delta=True, create=True)
944
945
    def get_factory(self):
946
        return KnitVersionedFile
1664.2.9 by Aaron Bentley
Ported weave merge test to versionedfile
947
948
949
class MergeCasesMixin(object):
950
951
    def doMerge(self, base, a, b, mp):
952
        from cStringIO import StringIO
953
        from textwrap import dedent
954
955
        def addcrlf(x):
956
            return x + '\n'
957
        
958
        w = self.get_file()
959
        w.add_lines('text0', [], map(addcrlf, base))
960
        w.add_lines('text1', ['text0'], map(addcrlf, a))
961
        w.add_lines('text2', ['text0'], map(addcrlf, b))
962
963
        self.log_contents(w)
964
965
        self.log('merge plan:')
966
        p = list(w.plan_merge('text1', 'text2'))
967
        for state, line in p:
968
            if line:
969
                self.log('%12s | %s' % (state, line[:-1]))
970
971
        self.log('merge:')
972
        mt = StringIO()
973
        mt.writelines(w.weave_merge(p))
974
        mt.seek(0)
975
        self.log(mt.getvalue())
976
977
        mp = map(addcrlf, mp)
978
        self.assertEqual(mt.readlines(), mp)
979
        
980
        
981
    def testOneInsert(self):
982
        self.doMerge([],
983
                     ['aa'],
984
                     [],
985
                     ['aa'])
986
987
    def testSeparateInserts(self):
988
        self.doMerge(['aaa', 'bbb', 'ccc'],
989
                     ['aaa', 'xxx', 'bbb', 'ccc'],
990
                     ['aaa', 'bbb', 'yyy', 'ccc'],
991
                     ['aaa', 'xxx', 'bbb', 'yyy', 'ccc'])
992
993
    def testSameInsert(self):
994
        self.doMerge(['aaa', 'bbb', 'ccc'],
995
                     ['aaa', 'xxx', 'bbb', 'ccc'],
996
                     ['aaa', 'xxx', 'bbb', 'yyy', 'ccc'],
997
                     ['aaa', 'xxx', 'bbb', 'yyy', 'ccc'])
998
    overlappedInsertExpected = ['aaa', 'xxx', 'yyy', 'bbb']
999
    def testOverlappedInsert(self):
1000
        self.doMerge(['aaa', 'bbb'],
1001
                     ['aaa', 'xxx', 'yyy', 'bbb'],
1002
                     ['aaa', 'xxx', 'bbb'], self.overlappedInsertExpected)
1003
1004
        # really it ought to reduce this to 
1005
        # ['aaa', 'xxx', 'yyy', 'bbb']
1006
1007
1008
    def testClashReplace(self):
1009
        self.doMerge(['aaa'],
1010
                     ['xxx'],
1011
                     ['yyy', 'zzz'],
1012
                     ['<<<<<<< ', 'xxx', '=======', 'yyy', 'zzz', 
1013
                      '>>>>>>> '])
1014
1015
    def testNonClashInsert1(self):
1016
        self.doMerge(['aaa'],
1017
                     ['xxx', 'aaa'],
1018
                     ['yyy', 'zzz'],
1019
                     ['<<<<<<< ', 'xxx', 'aaa', '=======', 'yyy', 'zzz', 
1020
                      '>>>>>>> '])
1021
1022
    def testNonClashInsert2(self):
1023
        self.doMerge(['aaa'],
1024
                     ['aaa'],
1025
                     ['yyy', 'zzz'],
1026
                     ['yyy', 'zzz'])
1027
1028
1029
    def testDeleteAndModify(self):
1030
        """Clashing delete and modification.
1031
1032
        If one side modifies a region and the other deletes it then
1033
        there should be a conflict with one side blank.
1034
        """
1035
1036
        #######################################
1037
        # skippd, not working yet
1038
        return
1039
        
1040
        self.doMerge(['aaa', 'bbb', 'ccc'],
1041
                     ['aaa', 'ddd', 'ccc'],
1042
                     ['aaa', 'ccc'],
1043
                     ['<<<<<<<< ', 'aaa', '=======', '>>>>>>> ', 'ccc'])
1044
1045
    def _test_merge_from_strings(self, base, a, b, expected):
1046
        w = self.get_file()
1047
        w.add_lines('text0', [], base.splitlines(True))
1048
        w.add_lines('text1', ['text0'], a.splitlines(True))
1049
        w.add_lines('text2', ['text0'], b.splitlines(True))
1050
        self.log('merge plan:')
1051
        p = list(w.plan_merge('text1', 'text2'))
1052
        for state, line in p:
1053
            if line:
1054
                self.log('%12s | %s' % (state, line[:-1]))
1055
        self.log('merge result:')
1056
        result_text = ''.join(w.weave_merge(p))
1057
        self.log(result_text)
1058
        self.assertEqualDiff(result_text, expected)
1059
1060
    def test_weave_merge_conflicts(self):
1061
        # does weave merge properly handle plans that end with unchanged?
1062
        result = ''.join(self.get_file().weave_merge([('new-a', 'hello\n')]))
1063
        self.assertEqual(result, 'hello\n')
1064
1065
    def test_deletion_extended(self):
1066
        """One side deletes, the other deletes more.
1067
        """
1068
        base = """\
1069
            line 1
1070
            line 2
1071
            line 3
1072
            """
1073
        a = """\
1074
            line 1
1075
            line 2
1076
            """
1077
        b = """\
1078
            line 1
1079
            """
1080
        result = """\
1081
            line 1
1082
            """
1083
        self._test_merge_from_strings(base, a, b, result)
1084
1085
    def test_deletion_overlap(self):
1086
        """Delete overlapping regions with no other conflict.
1087
1088
        Arguably it'd be better to treat these as agreement, rather than 
1089
        conflict, but for now conflict is safer.
1090
        """
1091
        base = """\
1092
            start context
1093
            int a() {}
1094
            int b() {}
1095
            int c() {}
1096
            end context
1097
            """
1098
        a = """\
1099
            start context
1100
            int a() {}
1101
            end context
1102
            """
1103
        b = """\
1104
            start context
1105
            int c() {}
1106
            end context
1107
            """
1108
        result = """\
1109
            start context
1110
<<<<<<< 
1111
            int a() {}
1112
=======
1113
            int c() {}
1114
>>>>>>> 
1115
            end context
1116
            """
1117
        self._test_merge_from_strings(base, a, b, result)
1118
1119
    def test_agreement_deletion(self):
1120
        """Agree to delete some lines, without conflicts."""
1121
        base = """\
1122
            start context
1123
            base line 1
1124
            base line 2
1125
            end context
1126
            """
1127
        a = """\
1128
            start context
1129
            base line 1
1130
            end context
1131
            """
1132
        b = """\
1133
            start context
1134
            base line 1
1135
            end context
1136
            """
1137
        result = """\
1138
            start context
1139
            base line 1
1140
            end context
1141
            """
1142
        self._test_merge_from_strings(base, a, b, result)
1143
1144
    def test_sync_on_deletion(self):
1145
        """Specific case of merge where we can synchronize incorrectly.
1146
        
1147
        A previous version of the weave merge concluded that the two versions
1148
        agreed on deleting line 2, and this could be a synchronization point.
1149
        Line 1 was then considered in isolation, and thought to be deleted on 
1150
        both sides.
1151
1152
        It's better to consider the whole thing as a disagreement region.
1153
        """
1154
        base = """\
1155
            start context
1156
            base line 1
1157
            base line 2
1158
            end context
1159
            """
1160
        a = """\
1161
            start context
1162
            base line 1
1163
            a's replacement line 2
1164
            end context
1165
            """
1166
        b = """\
1167
            start context
1168
            b replaces
1169
            both lines
1170
            end context
1171
            """
1172
        result = """\
1173
            start context
1174
<<<<<<< 
1175
            base line 1
1176
            a's replacement line 2
1177
=======
1178
            b replaces
1179
            both lines
1180
>>>>>>> 
1181
            end context
1182
            """
1183
        self._test_merge_from_strings(base, a, b, result)
1184
1185
1186
class TestKnitMerge(TestCaseWithTransport, MergeCasesMixin):
1187
1188
    def get_file(self, name='foo'):
1189
        return KnitVersionedFile(name, get_transport(self.get_url('.')),
1190
                                 delta=True, create=True)
1191
1192
    def log_contents(self, w):
1193
        pass
1194
1195
1196
class TestWeaveMerge(TestCaseWithTransport, MergeCasesMixin):
1197
1198
    def get_file(self, name='foo'):
1199
        return WeaveFile(name, get_transport(self.get_url('.')), create=True)
1200
1201
    def log_contents(self, w):
1202
        self.log('weave is:')
1203
        tmpf = StringIO()
1204
        write_weave(w, tmpf)
1205
        self.log(tmpf.getvalue())
1206
1207
    overlappedInsertExpected = ['aaa', '<<<<<<< ', 'xxx', 'yyy', '=======', 
1208
                                'xxx', '>>>>>>> ', 'bbb']