← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_shelf.py

  • Committer: John Arbash Meinel
  • Date: 2009-08-25 18:45:40 UTC
  • mto: (4634.6.15 2.0)
  • mto: This revision was merged to the branch mainline in revision 4667.
  • Revision ID: john@arbash-meinel.com-20090825184540-6dn3xjq62xhgj2gq
Add support for skipping ghost nodes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_shelf.py
 
1
# Copyright (C) 2008 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
import os
 
18
 
 
19
from bzrlib import (
 
20
    errors,
 
21
    osutils,
 
22
    pack,
 
23
    shelf,
 
24
    tests,
 
25
    transform,
 
26
    workingtree,
 
27
    )
 
28
 
 
29
 
 
30
EMPTY_SHELF = ("Bazaar pack format 1 (introduced in 0.18)\n"
 
31
               "B23\n"
 
32
               "metadata\n\n"
 
33
               "d11:revision_id5:null:e"
 
34
               "B159\n"
 
35
               "attribs\n\n"
 
36
               "d10:_id_numberi0e18:_new_executabilityde7:_new_idde"
 
37
               "9:_new_namede11:_new_parentde16:_non_present_idsde"
 
38
               "17:_removed_contentsle11:_removed_idle14:_tree_path_idsdeeE")
 
39
 
 
40
 
 
41
class TestPrepareShelf(tests.TestCaseWithTransport):
 
42
 
 
43
    def prepare_shelve_rename(self):
 
44
        tree = self.make_branch_and_tree('.')
 
45
        self.build_tree(['foo'])
 
46
        tree.add(['foo'], ['foo-id'])
 
47
        tree.commit('foo')
 
48
        tree.rename_one('foo', 'bar')
 
49
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
50
        self.addCleanup(creator.finalize)
 
51
        self.assertEqual([('rename', 'foo-id', 'foo', 'bar')],
 
52
                          list(creator.iter_shelvable()))
 
53
        return creator
 
54
 
 
55
    def check_shelve_rename(self, creator):
 
56
        work_trans_id = creator.work_transform.trans_id_file_id('foo-id')
 
57
        self.assertEqual('foo', creator.work_transform.final_name(
 
58
                         work_trans_id))
 
59
        shelf_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
 
60
        self.assertEqual('bar', creator.shelf_transform.final_name(
 
61
                         shelf_trans_id))
 
62
 
 
63
    def test_shelve_rename(self):
 
64
        self.thisFailsStrictLockCheck()
 
65
        creator = self.prepare_shelve_rename()
 
66
        creator.shelve_rename('foo-id')
 
67
        self.check_shelve_rename(creator)
 
68
 
 
69
    def test_shelve_change_handles_rename(self):
 
70
        self.thisFailsStrictLockCheck()
 
71
        creator = self.prepare_shelve_rename()
 
72
        creator.shelve_change(('rename', 'foo-id', 'foo', 'bar'))
 
73
        self.check_shelve_rename(creator)
 
74
 
 
75
    def prepare_shelve_move(self):
 
76
        tree = self.make_branch_and_tree('.')
 
77
        self.build_tree(['foo/', 'bar/', 'foo/baz'])
 
78
        tree.add(['foo', 'bar', 'foo/baz'], ['foo-id', 'bar-id', 'baz-id'])
 
79
        tree.commit('foo')
 
80
        tree.rename_one('foo/baz', 'bar/baz')
 
81
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
82
        self.addCleanup(creator.finalize)
 
83
        self.assertEqual([('rename', 'baz-id', 'foo/baz', 'bar/baz')],
 
84
                         list(creator.iter_shelvable()))
 
85
        return creator, tree
 
86
 
 
87
    def check_shelve_move(self, creator, tree):
 
88
        work_trans_id = creator.work_transform.trans_id_file_id('baz-id')
 
89
        work_foo = creator.work_transform.trans_id_file_id('foo-id')
 
90
        self.assertEqual(work_foo, creator.work_transform.final_parent(
 
91
                         work_trans_id))
 
92
        shelf_trans_id = creator.shelf_transform.trans_id_file_id('baz-id')
 
93
        shelf_bar = creator.shelf_transform.trans_id_file_id('bar-id')
 
94
        self.assertEqual(shelf_bar, creator.shelf_transform.final_parent(
 
95
                         shelf_trans_id))
 
96
        creator.transform()
 
97
        self.assertEqual('foo/baz', tree.id2path('baz-id'))
 
98
 
 
99
    def test_shelve_move(self):
 
100
        self.thisFailsStrictLockCheck()
 
101
        creator, tree = self.prepare_shelve_move()
 
102
        creator.shelve_rename('baz-id')
 
103
        self.check_shelve_move(creator, tree)
 
104
 
 
105
    def test_shelve_change_handles_move(self):
 
106
        self.thisFailsStrictLockCheck()
 
107
        creator, tree = self.prepare_shelve_move()
 
108
        creator.shelve_change(('rename', 'baz-id', 'foo/baz', 'bar/baz'))
 
109
        self.check_shelve_move(creator, tree)
 
110
 
 
111
    def assertShelvedFileEqual(self, expected_content, creator, file_id):
 
112
        s_trans_id = creator.shelf_transform.trans_id_file_id(file_id)
 
113
        shelf_file = creator.shelf_transform._limbo_name(s_trans_id)
 
114
        self.assertFileEqual(expected_content, shelf_file)
 
115
 
 
116
    def prepare_content_change(self):
 
117
        self.thisFailsStrictLockCheck()
 
118
        tree = self.make_branch_and_tree('.')
 
119
        tree.lock_write()
 
120
        self.addCleanup(tree.unlock)
 
121
        self.build_tree_contents([('foo', 'a\n')])
 
122
        tree.add('foo', 'foo-id')
 
123
        tree.commit('Committed foo')
 
124
        self.build_tree_contents([('foo', 'b\na\nc\n')])
 
125
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
126
        self.addCleanup(creator.finalize)
 
127
        return creator
 
128
 
 
129
    def test_shelve_content_change(self):
 
130
        creator = self.prepare_content_change()
 
131
        self.assertEqual([('modify text', 'foo-id')],
 
132
                         list(creator.iter_shelvable()))
 
133
        creator.shelve_lines('foo-id', ['a\n', 'c\n'])
 
134
        creator.transform()
 
135
        self.assertFileEqual('a\nc\n', 'foo')
 
136
        self.assertShelvedFileEqual('b\na\n', creator, 'foo-id')
 
137
 
 
138
    def test_shelve_change_handles_modify_text(self):
 
139
        creator = self.prepare_content_change()
 
140
        creator.shelve_change(('modify text', 'foo-id'))
 
141
        creator.transform()
 
142
        self.assertFileEqual('a\n', 'foo')
 
143
        self.assertShelvedFileEqual('b\na\nc\n', creator, 'foo-id')
 
144
 
 
145
    def test_shelve_all(self):
 
146
        creator = self.prepare_content_change()
 
147
        creator.shelve_all()
 
148
        creator.transform()
 
149
        self.assertFileEqual('a\n', 'foo')
 
150
        self.assertShelvedFileEqual('b\na\nc\n', creator, 'foo-id')
 
151
 
 
152
    def prepare_shelve_creation(self):
 
153
        tree = self.make_branch_and_tree('.')
 
154
        tree.lock_write()
 
155
        self.addCleanup(tree.unlock)
 
156
        tree.commit('Empty tree')
 
157
        self.build_tree_contents([('foo', 'a\n'), ('bar/',)])
 
158
        tree.add(['foo', 'bar'], ['foo-id', 'bar-id'])
 
159
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
160
        self.addCleanup(creator.finalize)
 
161
        self.assertEqual([('add file', 'bar-id', 'directory', 'bar'),
 
162
                          ('add file', 'foo-id', 'file', 'foo')],
 
163
                          sorted(list(creator.iter_shelvable())))
 
164
        return creator, tree
 
165
 
 
166
    def check_shelve_creation(self, creator, tree):
 
167
        self.assertRaises(StopIteration,
 
168
                          tree.iter_entries_by_dir(['foo-id']).next)
 
169
        s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
 
170
        self.assertEqual('foo-id',
 
171
                         creator.shelf_transform.final_file_id(s_trans_id))
 
172
        self.failIfExists('foo')
 
173
        self.failIfExists('bar')
 
174
        self.assertShelvedFileEqual('a\n', creator, 'foo-id')
 
175
        s_bar_trans_id = creator.shelf_transform.trans_id_file_id('bar-id')
 
176
        self.assertEqual('directory',
 
177
            creator.shelf_transform.final_kind(s_bar_trans_id))
 
178
 
 
179
    def test_shelve_creation(self):
 
180
        self.thisFailsStrictLockCheck()
 
181
        creator, tree = self.prepare_shelve_creation()
 
182
        creator.shelve_creation('foo-id')
 
183
        creator.shelve_creation('bar-id')
 
184
        creator.transform()
 
185
        self.check_shelve_creation(creator, tree)
 
186
 
 
187
    def test_shelve_change_handles_creation(self):
 
188
        self.thisFailsStrictLockCheck()
 
189
        creator, tree = self.prepare_shelve_creation()
 
190
        creator.shelve_change(('add file', 'foo-id', 'file', 'foo'))
 
191
        creator.shelve_change(('add file', 'bar-id', 'directory', 'bar'))
 
192
        creator.transform()
 
193
        self.check_shelve_creation(creator, tree)
 
194
 
 
195
    def _test_shelve_symlink_creation(self, link_name, link_target,
 
196
                                      shelve_change=False):
 
197
        self.requireFeature(tests.SymlinkFeature)
 
198
        tree = self.make_branch_and_tree('.')
 
199
        tree.lock_write()
 
200
        self.addCleanup(tree.unlock)
 
201
        tree.commit('Empty tree')
 
202
        os.symlink(link_target, link_name)
 
203
        tree.add(link_name, 'foo-id')
 
204
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
205
        self.addCleanup(creator.finalize)
 
206
        self.assertEqual([('add file', 'foo-id', 'symlink', link_name)],
 
207
                         list(creator.iter_shelvable()))
 
208
        if shelve_change:
 
209
            creator.shelve_change(('add file', 'foo-id', 'symlink', link_name))
 
210
        else:
 
211
            creator.shelve_creation('foo-id')
 
212
        creator.transform()
 
213
        s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
 
214
        self.failIfExists(link_name)
 
215
        limbo_name = creator.shelf_transform._limbo_name(s_trans_id)
 
216
        self.assertEqual(link_target, osutils.readlink(limbo_name))
 
217
        ptree = creator.shelf_transform.get_preview_tree()
 
218
        self.assertEqual(link_target, ptree.get_symlink_target('foo-id'))
 
219
 
 
220
    def test_shelve_symlink_creation(self):
 
221
        self.thisFailsStrictLockCheck()
 
222
        self._test_shelve_symlink_creation('foo', 'bar')
 
223
 
 
224
    def test_shelve_unicode_symlink_creation(self):
 
225
        self.requireFeature(tests.UnicodeFilenameFeature)
 
226
        self.thisFailsStrictLockCheck()
 
227
        self._test_shelve_symlink_creation(u'fo\N{Euro Sign}o',
 
228
                                           u'b\N{Euro Sign}ar')
 
229
 
 
230
    def test_shelve_change_handles_symlink_creation(self):
 
231
        self.thisFailsStrictLockCheck()
 
232
        self._test_shelve_symlink_creation('foo', 'bar', shelve_change=True)
 
233
 
 
234
    def _test_shelve_symlink_target_change(self, link_name,
 
235
                                           old_target, new_target,
 
236
                                           shelve_change=False):
 
237
        self.requireFeature(tests.SymlinkFeature)
 
238
        tree = self.make_branch_and_tree('.')
 
239
        tree.lock_write()
 
240
        self.addCleanup(tree.unlock)
 
241
        os.symlink(old_target, link_name)
 
242
        tree.add(link_name, 'foo-id')
 
243
        tree.commit("commit symlink")
 
244
        os.unlink(link_name)
 
245
        os.symlink(new_target, link_name)
 
246
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
247
        self.addCleanup(creator.finalize)
 
248
        self.assertEqual([('modify target', 'foo-id', link_name,
 
249
                           old_target, new_target)],
 
250
                         list(creator.iter_shelvable()))
 
251
        if shelve_change:
 
252
            creator.shelve_change(('modify target', 'foo-id', link_name,
 
253
                                   old_target, new_target))
 
254
        else:
 
255
            creator.shelve_modify_target('foo-id')
 
256
        creator.transform()
 
257
        self.assertEqual(old_target, osutils.readlink(link_name))
 
258
        s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
 
259
        limbo_name = creator.shelf_transform._limbo_name(s_trans_id)
 
260
        self.assertEqual(new_target, osutils.readlink(limbo_name))
 
261
        ptree = creator.shelf_transform.get_preview_tree()
 
262
        self.assertEqual(new_target, ptree.get_symlink_target('foo-id'))
 
263
 
 
264
    def test_shelve_symlink_target_change(self):
 
265
        self.thisFailsStrictLockCheck()
 
266
        self._test_shelve_symlink_target_change('foo', 'bar', 'baz')
 
267
 
 
268
    def test_shelve_unicode_symlink_target_change(self):
 
269
        self.thisFailsStrictLockCheck()
 
270
        self.requireFeature(tests.UnicodeFilenameFeature)
 
271
        self._test_shelve_symlink_target_change(
 
272
            u'fo\N{Euro Sign}o', u'b\N{Euro Sign}ar', u'b\N{Euro Sign}az')
 
273
 
 
274
    def test_shelve_change_handles_symlink_target_change(self):
 
275
        self.thisFailsStrictLockCheck()
 
276
        self._test_shelve_symlink_target_change('foo', 'bar', 'baz',
 
277
                                                shelve_change=True)
 
278
 
 
279
    def test_shelve_creation_no_contents(self):
 
280
        self.thisFailsStrictLockCheck()
 
281
        tree = self.make_branch_and_tree('.')
 
282
        tree.lock_write()
 
283
        self.addCleanup(tree.unlock)
 
284
        tree.commit('Empty tree')
 
285
        self.build_tree(['foo'])
 
286
        tree.add('foo', 'foo-id')
 
287
        os.unlink('foo')
 
288
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
289
        self.addCleanup(creator.finalize)
 
290
        self.assertEqual([('add file', 'foo-id', None, 'foo')],
 
291
                         sorted(list(creator.iter_shelvable())))
 
292
        creator.shelve_creation('foo-id')
 
293
        creator.transform()
 
294
        self.assertRaises(StopIteration,
 
295
                          tree.iter_entries_by_dir(['foo-id']).next)
 
296
        self.assertShelvedFileEqual('', creator, 'foo-id')
 
297
        s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
 
298
        self.assertEqual('foo-id',
 
299
                         creator.shelf_transform.final_file_id(s_trans_id))
 
300
        self.failIfExists('foo')
 
301
 
 
302
    def prepare_shelve_deletion(self):
 
303
        tree = self.make_branch_and_tree('tree')
 
304
        tree.lock_write()
 
305
        self.addCleanup(tree.unlock)
 
306
        self.build_tree_contents([('tree/foo/',), ('tree/foo/bar', 'baz')])
 
307
        tree.add(['foo', 'foo/bar'], ['foo-id', 'bar-id'])
 
308
        tree.commit('Added file and directory')
 
309
        tree.unversion(['foo-id', 'bar-id'])
 
310
        os.unlink('tree/foo/bar')
 
311
        os.rmdir('tree/foo')
 
312
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
313
        self.addCleanup(creator.finalize)
 
314
        self.assertEqual([('delete file', 'bar-id', 'file', 'foo/bar'),
 
315
                          ('delete file', 'foo-id', 'directory', 'foo')],
 
316
                          sorted(list(creator.iter_shelvable())))
 
317
        return creator, tree
 
318
 
 
319
    def check_shelve_deletion(self, tree):
 
320
        self.assertTrue('foo-id' in tree)
 
321
        self.assertTrue('bar-id' in tree)
 
322
        self.assertFileEqual('baz', 'tree/foo/bar')
 
323
 
 
324
    def test_shelve_deletion(self):
 
325
        self.thisFailsStrictLockCheck()
 
326
        creator, tree = self.prepare_shelve_deletion()
 
327
        creator.shelve_deletion('foo-id')
 
328
        creator.shelve_deletion('bar-id')
 
329
        creator.transform()
 
330
        self.check_shelve_deletion(tree)
 
331
 
 
332
    def test_shelve_change_handles_deletion(self):
 
333
        self.thisFailsStrictLockCheck()
 
334
        creator, tree = self.prepare_shelve_deletion()
 
335
        creator.shelve_change(('delete file', 'foo-id', 'directory', 'foo'))
 
336
        creator.shelve_change(('delete file', 'bar-id', 'file', 'foo/bar'))
 
337
        creator.transform()
 
338
        self.check_shelve_deletion(tree)
 
339
 
 
340
    def test_shelve_delete_contents(self):
 
341
        self.thisFailsStrictLockCheck()
 
342
        tree = self.make_branch_and_tree('tree')
 
343
        self.build_tree(['tree/foo',])
 
344
        tree.add('foo', 'foo-id')
 
345
        tree.commit('Added file and directory')
 
346
        os.unlink('tree/foo')
 
347
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
348
        self.addCleanup(creator.finalize)
 
349
        self.assertEqual([('delete file', 'foo-id', 'file', 'foo')],
 
350
                         sorted(list(creator.iter_shelvable())))
 
351
        creator.shelve_deletion('foo-id')
 
352
        creator.transform()
 
353
        self.failUnlessExists('tree/foo')
 
354
 
 
355
    def prepare_shelve_change_kind(self):
 
356
        tree = self.make_branch_and_tree('tree')
 
357
        self.build_tree_contents([('tree/foo', 'bar')])
 
358
        tree.add('foo', 'foo-id')
 
359
        tree.commit('Added file and directory')
 
360
        os.unlink('tree/foo')
 
361
        os.mkdir('tree/foo')
 
362
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
363
        self.addCleanup(creator.finalize)
 
364
        self.assertEqual([('change kind', 'foo-id', 'file', 'directory',
 
365
                           'foo')], sorted(list(creator.iter_shelvable())))
 
366
        return creator
 
367
 
 
368
    def check_shelve_change_kind(self, creator):
 
369
        self.assertFileEqual('bar', 'tree/foo')
 
370
        s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
 
371
        self.assertEqual('directory',
 
372
                         creator.shelf_transform._new_contents[s_trans_id])
 
373
 
 
374
    def test_shelve_change_kind(self):
 
375
        self.thisFailsStrictLockCheck()
 
376
        creator = self.prepare_shelve_change_kind()
 
377
        creator.shelve_content_change('foo-id')
 
378
        creator.transform()
 
379
        self.check_shelve_change_kind(creator)
 
380
 
 
381
    def test_shelve_change_handles_change_kind(self):
 
382
        self.thisFailsStrictLockCheck()
 
383
        creator = self.prepare_shelve_change_kind()
 
384
        creator.shelve_change(('change kind', 'foo-id', 'file', 'directory',
 
385
                               'foo'))
 
386
        creator.transform()
 
387
        self.check_shelve_change_kind(creator)
 
388
 
 
389
    def test_shelve_change_unknown_change(self):
 
390
        self.thisFailsStrictLockCheck()
 
391
        tree = self.make_branch_and_tree('tree')
 
392
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
393
        self.addCleanup(creator.finalize)
 
394
        e = self.assertRaises(ValueError, creator.shelve_change, ('unknown',))
 
395
        self.assertEqual('Unknown change kind: "unknown"', str(e))
 
396
 
 
397
    def test_shelve_unversion(self):
 
398
        self.thisFailsStrictLockCheck()
 
399
        tree = self.make_branch_and_tree('tree')
 
400
        self.build_tree(['tree/foo',])
 
401
        tree.add('foo', 'foo-id')
 
402
        tree.commit('Added file and directory')
 
403
        tree.unversion(['foo-id'])
 
404
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
405
        self.addCleanup(creator.finalize)
 
406
        self.assertEqual([('delete file', 'foo-id', 'file', 'foo')],
 
407
                         sorted(list(creator.iter_shelvable())))
 
408
        creator.shelve_deletion('foo-id')
 
409
        creator.transform()
 
410
        self.failUnlessExists('tree/foo')
 
411
 
 
412
    def test_shelve_serialization(self):
 
413
        self.thisFailsStrictLockCheck()
 
414
        tree = self.make_branch_and_tree('.')
 
415
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
416
        self.addCleanup(creator.finalize)
 
417
        shelf_file = open('shelf', 'wb')
 
418
        self.addCleanup(shelf_file.close)
 
419
        try:
 
420
            creator.write_shelf(shelf_file)
 
421
        finally:
 
422
            shelf_file.close()
 
423
        self.assertFileEqual(EMPTY_SHELF, 'shelf')
 
424
 
 
425
    def test_write_shelf(self):
 
426
        self.thisFailsStrictLockCheck()
 
427
        tree = self.make_branch_and_tree('tree')
 
428
        self.build_tree(['tree/foo'])
 
429
        tree.add('foo', 'foo-id')
 
430
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
431
        self.addCleanup(creator.finalize)
 
432
        list(creator.iter_shelvable())
 
433
        creator.shelve_creation('foo-id')
 
434
        shelf_file = open('shelf', 'wb')
 
435
        try:
 
436
            creator.write_shelf(shelf_file)
 
437
        finally:
 
438
            shelf_file.close()
 
439
        parser = pack.ContainerPushParser()
 
440
        shelf_file = open('shelf', 'rb')
 
441
        try:
 
442
            parser.accept_bytes(shelf_file.read())
 
443
        finally:
 
444
            shelf_file.close()
 
445
        tt = transform.TransformPreview(tree)
 
446
        self.addCleanup(tt.finalize)
 
447
        records = iter(parser.read_pending_records())
 
448
        #skip revision-id
 
449
        records.next()
 
450
        tt.deserialize(records)
 
451
 
 
452
    def test_shelve_unversioned(self):
 
453
        self.thisFailsStrictLockCheck()
 
454
        tree = self.make_branch_and_tree('tree')
 
455
        self.assertRaises(errors.PathsNotVersionedError,
 
456
                          shelf.ShelfCreator, tree, tree.basis_tree(), ['foo'])
 
457
        # We should be able to lock/unlock the tree if ShelfCreator cleaned
 
458
        # after itself.
 
459
        wt = workingtree.WorkingTree.open('tree')
 
460
        wt.lock_tree_write()
 
461
        wt.unlock()
 
462
        # And a second tentative should raise the same error (no
 
463
        # limbo/pending_deletion leftovers).
 
464
        self.assertRaises(errors.PathsNotVersionedError,
 
465
                          shelf.ShelfCreator, tree, tree.basis_tree(), ['foo'])
 
466
 
 
467
    def test_shelve_skips_added_root(self):
 
468
        """Skip adds of the root when iterating through shelvable changes."""
 
469
        tree = self.make_branch_and_tree('tree')
 
470
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
471
        self.addCleanup(creator.finalize)
 
472
        self.assertEqual([], list(creator.iter_shelvable()))
 
473
 
 
474
 
 
475
class TestUnshelver(tests.TestCaseWithTransport):
 
476
 
 
477
    def test_make_merger(self):
 
478
        self.thisFailsStrictLockCheck()
 
479
        tree = self.make_branch_and_tree('tree')
 
480
        tree.commit('first commit')
 
481
        self.build_tree_contents([('tree/foo', 'bar')])
 
482
        tree.lock_write()
 
483
        self.addCleanup(tree.unlock)
 
484
        tree.add('foo', 'foo-id')
 
485
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
486
        self.addCleanup(creator.finalize)
 
487
        list(creator.iter_shelvable())
 
488
        creator.shelve_creation('foo-id')
 
489
        shelf_file = open('shelf-file', 'w+b')
 
490
        try:
 
491
            creator.write_shelf(shelf_file)
 
492
            creator.transform()
 
493
            shelf_file.seek(0)
 
494
            unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
 
495
            unshelver.make_merger().do_merge()
 
496
            self.assertFileEqual('bar', 'tree/foo')
 
497
        finally:
 
498
            shelf_file.close()
 
499
 
 
500
    def test_unshelve_changed(self):
 
501
        self.thisFailsStrictLockCheck()
 
502
        tree = self.make_branch_and_tree('tree')
 
503
        tree.lock_write()
 
504
        self.addCleanup(tree.unlock)
 
505
        self.build_tree_contents([('tree/foo', 'a\nb\nc\n')])
 
506
        tree.add('foo', 'foo-id')
 
507
        tree.commit('first commit')
 
508
        self.build_tree_contents([('tree/foo', 'a\nb\nd\n')])
 
509
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
510
        self.addCleanup(creator.finalize)
 
511
        list(creator.iter_shelvable())
 
512
        creator.shelve_lines('foo-id', ['a\n', 'b\n', 'c\n'])
 
513
        shelf_file = open('shelf', 'w+b')
 
514
        self.addCleanup(shelf_file.close)
 
515
        creator.write_shelf(shelf_file)
 
516
        creator.transform()
 
517
        self.build_tree_contents([('tree/foo', 'z\na\nb\nc\n')])
 
518
        shelf_file.seek(0)
 
519
        unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
 
520
        unshelver.make_merger().do_merge()
 
521
        self.assertFileEqual('z\na\nb\nd\n', 'tree/foo')
 
522
 
 
523
    def test_unshelve_deleted(self):
 
524
        self.thisFailsStrictLockCheck()
 
525
        tree = self.make_branch_and_tree('tree')
 
526
        tree.lock_write()
 
527
        self.addCleanup(tree.unlock)
 
528
        self.build_tree_contents([('tree/foo/',), ('tree/foo/bar', 'baz')])
 
529
        tree.add(['foo', 'foo/bar'], ['foo-id', 'bar-id'])
 
530
        tree.commit('Added file and directory')
 
531
        tree.unversion(['foo-id', 'bar-id'])
 
532
        os.unlink('tree/foo/bar')
 
533
        os.rmdir('tree/foo')
 
534
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
535
        list(creator.iter_shelvable())
 
536
        creator.shelve_deletion('foo-id')
 
537
        creator.shelve_deletion('bar-id')
 
538
        shelf_file = open('shelf', 'w+b')
 
539
        self.addCleanup(shelf_file.close)
 
540
        creator.write_shelf(shelf_file)
 
541
        creator.transform()
 
542
        creator.finalize()
 
543
        # validate the test setup
 
544
        self.assertTrue('foo-id' in tree)
 
545
        self.assertTrue('bar-id' in tree)
 
546
        self.assertFileEqual('baz', 'tree/foo/bar')
 
547
        shelf_file.seek(0)
 
548
        unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
 
549
        unshelver.make_merger().do_merge()
 
550
        self.assertFalse('foo-id' in tree)
 
551
        self.assertFalse('bar-id' in tree)
 
552
 
 
553
    def test_unshelve_base(self):
 
554
        self.thisFailsStrictLockCheck()
 
555
        tree = self.make_branch_and_tree('tree')
 
556
        tree.lock_write()
 
557
        self.addCleanup(tree.unlock)
 
558
        tree.commit('rev1', rev_id='rev1')
 
559
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
560
        self.addCleanup(creator.finalize)
 
561
        manager = tree.get_shelf_manager()
 
562
        shelf_id, shelf_file = manager.new_shelf()
 
563
        try:
 
564
            creator.write_shelf(shelf_file)
 
565
        finally:
 
566
            shelf_file.close()
 
567
        tree.commit('rev2', rev_id='rev2')
 
568
        shelf_file = manager.read_shelf(1)
 
569
        self.addCleanup(shelf_file.close)
 
570
        unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
 
571
        self.addCleanup(unshelver.finalize)
 
572
        self.assertEqual('rev1', unshelver.base_tree.get_revision_id())
 
573
 
 
574
    def test_unshelve_serialization(self):
 
575
        self.thisFailsStrictLockCheck()
 
576
        tree = self.make_branch_and_tree('.')
 
577
        self.build_tree_contents([('shelf', EMPTY_SHELF)])
 
578
        shelf_file = open('shelf', 'rb')
 
579
        self.addCleanup(shelf_file.close)
 
580
        unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
 
581
 
 
582
    def test_corrupt_shelf(self):
 
583
        self.thisFailsStrictLockCheck()
 
584
        tree = self.make_branch_and_tree('.')
 
585
        self.build_tree_contents([('shelf', EMPTY_SHELF.replace('metadata',
 
586
                                                                'foo'))])
 
587
        shelf_file = open('shelf', 'rb')
 
588
        self.addCleanup(shelf_file.close)
 
589
        e = self.assertRaises(errors.ShelfCorrupt,
 
590
                              shelf.Unshelver.from_tree_and_shelf, tree,
 
591
                              shelf_file)
 
592
        self.assertEqual('Shelf corrupt.', str(e))
 
593
 
 
594
 
 
595
class TestShelfManager(tests.TestCaseWithTransport):
 
596
 
 
597
    def test_get_shelf_manager(self):
 
598
        tree = self.make_branch_and_tree('.')
 
599
        manager = tree.get_shelf_manager()
 
600
        self.assertEqual(tree._transport.base + 'shelf/',
 
601
                         manager.transport.base)
 
602
 
 
603
    def get_manager(self):
 
604
        return self.make_branch_and_tree('.').get_shelf_manager()
 
605
 
 
606
    def test_get_shelf_filename(self):
 
607
        tree = self.make_branch_and_tree('.')
 
608
        manager = tree.get_shelf_manager()
 
609
        self.assertEqual('shelf-1', manager.get_shelf_filename(1))
 
610
 
 
611
    def test_get_shelf_ids(self):
 
612
        tree = self.make_branch_and_tree('.')
 
613
        manager = tree.get_shelf_manager()
 
614
        self.assertEqual([1, 3], manager.get_shelf_ids(
 
615
                         ['shelf-1', 'shelf-02', 'shelf-3']))
 
616
 
 
617
    def test_new_shelf(self):
 
618
        manager = self.get_manager()
 
619
        shelf_id, shelf_file = manager.new_shelf()
 
620
        shelf_file.close()
 
621
        self.assertEqual(1, shelf_id)
 
622
        shelf_id, shelf_file = manager.new_shelf()
 
623
        shelf_file.close()
 
624
        self.assertEqual(2, shelf_id)
 
625
        manager.delete_shelf(1)
 
626
        shelf_id, shelf_file = manager.new_shelf()
 
627
        shelf_file.close()
 
628
        self.assertEqual(3, shelf_id)
 
629
 
 
630
    def test_active_shelves(self):
 
631
        manager = self.get_manager()
 
632
        self.assertEqual([], manager.active_shelves())
 
633
        shelf_id, shelf_file = manager.new_shelf()
 
634
        shelf_file.close()
 
635
        self.assertEqual([1], manager.active_shelves())
 
636
 
 
637
    def test_delete_shelf(self):
 
638
        manager = self.get_manager()
 
639
        shelf_id, shelf_file = manager.new_shelf()
 
640
        shelf_file.close()
 
641
        self.assertEqual([1], manager.active_shelves())
 
642
        manager.delete_shelf(1)
 
643
        self.assertEqual([], manager.active_shelves())
 
644
 
 
645
    def test_last_shelf(self):
 
646
        manager = self.get_manager()
 
647
        self.assertIs(None, manager.last_shelf())
 
648
        shelf_id, shelf_file = manager.new_shelf()
 
649
        shelf_file.close()
 
650
        self.assertEqual(1, manager.last_shelf())
 
651
 
 
652
    def test_read_shelf(self):
 
653
        manager = self.get_manager()
 
654
        shelf_id, shelf_file = manager.new_shelf()
 
655
        try:
 
656
            shelf_file.write('foo')
 
657
        finally:
 
658
            shelf_file.close()
 
659
        shelf_id, shelf_file = manager.new_shelf()
 
660
        try:
 
661
            shelf_file.write('bar')
 
662
        finally:
 
663
            shelf_file.close()
 
664
        shelf_file = manager.read_shelf(1)
 
665
        try:
 
666
            self.assertEqual('foo', shelf_file.read())
 
667
        finally:
 
668
            shelf_file.close()
 
669
        shelf_file = manager.read_shelf(2)
 
670
        try:
 
671
            self.assertEqual('bar', shelf_file.read())
 
672
        finally:
 
673
            shelf_file.close()
 
674
 
 
675
    def test_read_non_existant(self):
 
676
        manager = self.get_manager()
 
677
        e = self.assertRaises(errors.NoSuchShelfId, manager.read_shelf, 1)
 
678
        self.assertEqual('No changes are shelved with id "1".', str(e))
 
679
 
 
680
    def test_shelve_changes(self):
 
681
        tree = self.make_branch_and_tree('tree')
 
682
        tree.commit('no-change commit')
 
683
        tree.lock_write()
 
684
        self.addCleanup(tree.unlock)
 
685
        self.build_tree_contents([('tree/foo', 'bar')])
 
686
        self.assertFileEqual('bar', 'tree/foo')
 
687
        tree.add('foo', 'foo-id')
 
688
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
689
        self.addCleanup(creator.finalize)
 
690
        list(creator.iter_shelvable())
 
691
        creator.shelve_creation('foo-id')
 
692
        shelf_manager = tree.get_shelf_manager()
 
693
        shelf_id = shelf_manager.shelve_changes(creator)
 
694
        self.failIfExists('tree/foo')
 
695
        unshelver = shelf_manager.get_unshelver(shelf_id)
 
696
        unshelver.make_merger().do_merge()
 
697
        self.assertFileEqual('bar', 'tree/foo')
 
698
 
 
699
    def test_get_metadata(self):
 
700
        tree = self.make_branch_and_tree('.')
 
701
        creator = shelf.ShelfCreator(tree, tree.basis_tree())
 
702
        shelf_manager = tree.get_shelf_manager()
 
703
        shelf_id = shelf_manager.shelve_changes(creator, 'foo')
 
704
        metadata = shelf_manager.get_metadata(shelf_id)
 
705
        self.assertEqual('foo', metadata['message'])
 
706
        self.assertEqual('null:', metadata['revision_id'])