1
# Copyright (C) 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
from bzrlib import errors, pack, shelf, tests, transform, workingtree
22
EMPTY_SHELF = ("Bazaar pack format 1 (introduced in 0.18)\n"
25
"d11:revision_id5:null:e"
28
"d10:_id_numberi0e18:_new_executabilityde7:_new_idde"
29
"9:_new_namede11:_new_parentde16:_non_present_idsde"
30
"17:_removed_contentsle11:_removed_idle14:_tree_path_idsdeeE")
33
class TestPrepareShelf(tests.TestCaseWithTransport):
35
def test_shelve_rename(self):
36
tree = self.make_branch_and_tree('.')
37
self.build_tree(['foo'])
38
tree.add(['foo'], ['foo-id'])
40
tree.rename_one('foo', 'bar')
41
creator = shelf.ShelfCreator(tree, tree.basis_tree())
42
self.addCleanup(creator.finalize)
43
self.assertEqual([('rename', 'foo-id', 'foo', 'bar')],
44
list(creator.iter_shelvable()))
45
creator.shelve_rename('foo-id')
46
work_trans_id = creator.work_transform.trans_id_file_id('foo-id')
47
self.assertEqual('foo', creator.work_transform.final_name(
49
shelf_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
50
self.assertEqual('bar', creator.shelf_transform.final_name(
53
def test_shelve_move(self):
54
tree = self.make_branch_and_tree('.')
55
self.build_tree(['foo/', 'bar/', 'foo/baz'])
56
tree.add(['foo', 'bar', 'foo/baz'], ['foo-id', 'bar-id', 'baz-id'])
58
tree.rename_one('foo/baz', 'bar/baz')
59
creator = shelf.ShelfCreator(tree, tree.basis_tree())
60
self.addCleanup(creator.finalize)
61
self.assertEqual([('rename', 'baz-id', 'foo/baz', 'bar/baz')],
62
list(creator.iter_shelvable()))
63
creator.shelve_rename('baz-id')
64
work_trans_id = creator.work_transform.trans_id_file_id('baz-id')
65
work_foo = creator.work_transform.trans_id_file_id('foo-id')
66
self.assertEqual(work_foo, creator.work_transform.final_parent(
68
shelf_trans_id = creator.shelf_transform.trans_id_file_id('baz-id')
69
shelf_bar = creator.shelf_transform.trans_id_file_id('bar-id')
70
self.assertEqual(shelf_bar, creator.shelf_transform.final_parent(
73
self.assertEqual('foo/baz', tree.id2path('baz-id'))
75
def assertShelvedFileEqual(self, expected_content, creator, file_id):
76
s_trans_id = creator.shelf_transform.trans_id_file_id(file_id)
77
shelf_file = creator.shelf_transform._limbo_name(s_trans_id)
78
self.assertFileEqual(expected_content, shelf_file)
80
def test_shelve_content_change(self):
81
tree = self.make_branch_and_tree('.')
83
self.addCleanup(tree.unlock)
84
self.build_tree_contents([('foo', 'a\n')])
85
tree.add('foo', 'foo-id')
86
tree.commit('Committed foo')
87
self.build_tree_contents([('foo', 'b\na\nc\n')])
88
creator = shelf.ShelfCreator(tree, tree.basis_tree())
89
self.addCleanup(creator.finalize)
90
self.assertEqual([('modify text', 'foo-id')],
91
list(creator.iter_shelvable()))
92
creator.shelve_lines('foo-id', ['a\n', 'c\n'])
94
self.assertFileEqual('a\nc\n', 'foo')
95
self.assertShelvedFileEqual('b\na\n', creator, 'foo-id')
97
def test_shelve_creation(self):
98
tree = self.make_branch_and_tree('.')
100
self.addCleanup(tree.unlock)
101
tree.commit('Empty tree')
102
self.build_tree_contents([('foo', 'a\n'), ('bar/',)])
103
tree.add(['foo', 'bar'], ['foo-id', 'bar-id'])
104
creator = shelf.ShelfCreator(tree, tree.basis_tree())
105
self.addCleanup(creator.finalize)
106
self.assertEqual([('add file', 'bar-id', 'directory', 'bar'),
107
('add file', 'foo-id', 'file', 'foo')],
108
sorted(list(creator.iter_shelvable())))
109
creator.shelve_creation('foo-id')
110
creator.shelve_creation('bar-id')
112
self.assertRaises(StopIteration,
113
tree.iter_entries_by_dir(['foo-id']).next)
114
s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
115
self.assertEqual('foo-id',
116
creator.shelf_transform.final_file_id(s_trans_id))
117
self.failIfExists('foo')
118
self.failIfExists('bar')
119
self.assertShelvedFileEqual('a\n', creator, 'foo-id')
120
s_bar_trans_id = creator.shelf_transform.trans_id_file_id('bar-id')
121
self.assertEqual('directory',
122
creator.shelf_transform.final_kind(s_bar_trans_id))
124
def test_shelve_symlink_creation(self):
125
self.requireFeature(tests.SymlinkFeature)
126
tree = self.make_branch_and_tree('.')
128
self.addCleanup(tree.unlock)
129
tree.commit('Empty tree')
130
os.symlink('bar', 'foo')
131
tree.add('foo', 'foo-id')
132
creator = shelf.ShelfCreator(tree, tree.basis_tree())
133
self.addCleanup(creator.finalize)
134
self.assertEqual([('add file', 'foo-id', 'symlink', 'foo')],
135
list(creator.iter_shelvable()))
136
creator.shelve_creation('foo-id')
138
s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
139
self.failIfExists('foo')
140
limbo_name = creator.shelf_transform._limbo_name(s_trans_id)
141
self.assertEqual('bar', os.readlink(limbo_name))
143
def test_shelve_symlink_target_change(self):
144
self.requireFeature(tests.SymlinkFeature)
145
tree = self.make_branch_and_tree('.')
147
self.addCleanup(tree.unlock)
148
os.symlink('bar', 'foo')
149
tree.add('foo', 'foo-id')
150
tree.commit("commit symlink")
152
os.symlink('baz', 'foo')
153
creator = shelf.ShelfCreator(tree, tree.basis_tree())
154
self.addCleanup(creator.finalize)
155
self.assertEqual([('modify target', 'foo-id', 'foo', 'bar', 'baz')],
156
list(creator.iter_shelvable()))
157
creator.shelve_modify_target('foo-id')
159
self.assertEqual('bar', os.readlink('foo'))
160
s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
161
limbo_name = creator.shelf_transform._limbo_name(s_trans_id)
162
self.assertEqual('baz', os.readlink(limbo_name))
164
def test_shelve_creation_no_contents(self):
165
tree = self.make_branch_and_tree('.')
167
self.addCleanup(tree.unlock)
168
tree.commit('Empty tree')
169
self.build_tree(['foo'])
170
tree.add('foo', 'foo-id')
172
creator = shelf.ShelfCreator(tree, tree.basis_tree())
173
self.addCleanup(creator.finalize)
174
self.assertEqual([('add file', 'foo-id', None, 'foo')],
175
sorted(list(creator.iter_shelvable())))
176
creator.shelve_creation('foo-id')
178
self.assertRaises(StopIteration,
179
tree.iter_entries_by_dir(['foo-id']).next)
180
self.assertShelvedFileEqual('', creator, 'foo-id')
181
s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
182
self.assertEqual('foo-id',
183
creator.shelf_transform.final_file_id(s_trans_id))
184
self.failIfExists('foo')
186
def test_shelve_deletion(self):
187
tree = self.make_branch_and_tree('tree')
189
self.addCleanup(tree.unlock)
190
self.build_tree_contents([('tree/foo/',), ('tree/foo/bar', 'baz')])
191
tree.add(['foo', 'foo/bar'], ['foo-id', 'bar-id'])
192
tree.commit('Added file and directory')
193
tree.unversion(['foo-id', 'bar-id'])
194
os.unlink('tree/foo/bar')
196
creator = shelf.ShelfCreator(tree, tree.basis_tree())
197
self.addCleanup(creator.finalize)
198
self.assertEqual([('delete file', 'bar-id', 'file', 'foo/bar'),
199
('delete file', 'foo-id', 'directory', 'foo')],
200
sorted(list(creator.iter_shelvable())))
201
creator.shelve_deletion('foo-id')
202
creator.shelve_deletion('bar-id')
204
self.assertTrue('foo-id' in tree)
205
self.assertTrue('bar-id' in tree)
206
self.assertFileEqual('baz', 'tree/foo/bar')
208
def test_shelve_delete_contents(self):
209
tree = self.make_branch_and_tree('tree')
210
self.build_tree(['tree/foo',])
211
tree.add('foo', 'foo-id')
212
tree.commit('Added file and directory')
213
os.unlink('tree/foo')
214
creator = shelf.ShelfCreator(tree, tree.basis_tree())
215
self.addCleanup(creator.finalize)
216
self.assertEqual([('delete file', 'foo-id', 'file', 'foo')],
217
sorted(list(creator.iter_shelvable())))
218
creator.shelve_deletion('foo-id')
220
self.failUnlessExists('tree/foo')
222
def test_shelve_change_kind(self):
223
tree = self.make_branch_and_tree('tree')
224
self.build_tree_contents([('tree/foo', 'bar')])
225
tree.add('foo', 'foo-id')
226
tree.commit('Added file and directory')
227
os.unlink('tree/foo')
229
creator = shelf.ShelfCreator(tree, tree.basis_tree())
230
self.addCleanup(creator.finalize)
231
self.assertEqual([('change kind', 'foo-id', 'file', 'directory',
232
'foo')], sorted(list(creator.iter_shelvable())))
233
creator.shelve_content_change('foo-id')
235
self.assertFileEqual('bar', 'tree/foo')
236
s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
237
self.assertEqual('directory',
238
creator.shelf_transform._new_contents[s_trans_id])
240
def test_shelve_unversion(self):
241
tree = self.make_branch_and_tree('tree')
242
self.build_tree(['tree/foo',])
243
tree.add('foo', 'foo-id')
244
tree.commit('Added file and directory')
245
tree.unversion(['foo-id'])
246
creator = shelf.ShelfCreator(tree, tree.basis_tree())
247
self.addCleanup(creator.finalize)
248
self.assertEqual([('delete file', 'foo-id', 'file', 'foo')],
249
sorted(list(creator.iter_shelvable())))
250
creator.shelve_deletion('foo-id')
252
self.failUnlessExists('tree/foo')
254
def test_shelve_serialization(self):
255
tree = self.make_branch_and_tree('.')
256
creator = shelf.ShelfCreator(tree, tree.basis_tree())
257
self.addCleanup(creator.finalize)
258
shelf_file = open('shelf', 'wb')
259
self.addCleanup(shelf_file.close)
261
creator.write_shelf(shelf_file)
264
self.assertFileEqual(EMPTY_SHELF, 'shelf')
266
def test_write_shelf(self):
267
tree = self.make_branch_and_tree('tree')
268
self.build_tree(['tree/foo'])
269
tree.add('foo', 'foo-id')
270
creator = shelf.ShelfCreator(tree, tree.basis_tree())
271
self.addCleanup(creator.finalize)
272
list(creator.iter_shelvable())
273
creator.shelve_creation('foo-id')
274
shelf_file = open('shelf', 'wb')
276
creator.write_shelf(shelf_file)
279
parser = pack.ContainerPushParser()
280
shelf_file = open('shelf', 'rb')
282
parser.accept_bytes(shelf_file.read())
285
tt = transform.TransformPreview(tree)
286
self.addCleanup(tt.finalize)
287
records = iter(parser.read_pending_records())
290
tt.deserialize(records)
292
def test_shelve_unversioned(self):
293
tree = self.make_branch_and_tree('tree')
294
self.assertRaises(errors.PathsNotVersionedError,
295
shelf.ShelfCreator, tree, tree.basis_tree(), ['foo'])
296
# We should be able to lock/unlock the tree if ShelfCreator cleaned
298
wt = workingtree.WorkingTree.open('tree')
301
# And a second tentative should raise the same error (no
302
# limbo/pending_deletion leftovers).
303
self.assertRaises(errors.PathsNotVersionedError,
304
shelf.ShelfCreator, tree, tree.basis_tree(), ['foo'])
307
class TestUnshelver(tests.TestCaseWithTransport):
309
def test_make_merger(self):
310
tree = self.make_branch_and_tree('tree')
311
tree.commit('first commit')
312
self.build_tree_contents([('tree/foo', 'bar')])
314
self.addCleanup(tree.unlock)
315
tree.add('foo', 'foo-id')
316
creator = shelf.ShelfCreator(tree, tree.basis_tree())
317
self.addCleanup(creator.finalize)
318
list(creator.iter_shelvable())
319
creator.shelve_creation('foo-id')
320
shelf_file = open('shelf-file', 'w+b')
322
creator.write_shelf(shelf_file)
325
unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
326
unshelver.make_merger().do_merge()
327
self.assertFileEqual('bar', 'tree/foo')
331
def test_unshelve_changed(self):
332
tree = self.make_branch_and_tree('tree')
334
self.addCleanup(tree.unlock)
335
self.build_tree_contents([('tree/foo', 'a\nb\nc\n')])
336
tree.add('foo', 'foo-id')
337
tree.commit('first commit')
338
self.build_tree_contents([('tree/foo', 'a\nb\nd\n')])
339
creator = shelf.ShelfCreator(tree, tree.basis_tree())
340
self.addCleanup(creator.finalize)
341
list(creator.iter_shelvable())
342
creator.shelve_lines('foo-id', ['a\n', 'b\n', 'c\n'])
343
shelf_file = open('shelf', 'w+b')
344
self.addCleanup(shelf_file.close)
345
creator.write_shelf(shelf_file)
347
self.build_tree_contents([('tree/foo', 'z\na\nb\nc\n')])
349
unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
350
unshelver.make_merger().do_merge()
351
self.assertFileEqual('z\na\nb\nd\n', 'tree/foo')
353
def test_unshelve_deleted(self):
354
tree = self.make_branch_and_tree('tree')
356
self.addCleanup(tree.unlock)
357
self.build_tree_contents([('tree/foo/',), ('tree/foo/bar', 'baz')])
358
tree.add(['foo', 'foo/bar'], ['foo-id', 'bar-id'])
359
tree.commit('Added file and directory')
360
tree.unversion(['foo-id', 'bar-id'])
361
os.unlink('tree/foo/bar')
363
creator = shelf.ShelfCreator(tree, tree.basis_tree())
364
list(creator.iter_shelvable())
365
creator.shelve_deletion('foo-id')
366
creator.shelve_deletion('bar-id')
367
shelf_file = open('shelf', 'w+b')
368
self.addCleanup(shelf_file.close)
369
creator.write_shelf(shelf_file)
372
# validate the test setup
373
self.assertTrue('foo-id' in tree)
374
self.assertTrue('bar-id' in tree)
375
self.assertFileEqual('baz', 'tree/foo/bar')
377
unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
378
unshelver.make_merger().do_merge()
379
self.assertFalse('foo-id' in tree)
380
self.assertFalse('bar-id' in tree)
382
def test_unshelve_base(self):
383
tree = self.make_branch_and_tree('tree')
385
self.addCleanup(tree.unlock)
386
tree.commit('rev1', rev_id='rev1')
387
creator = shelf.ShelfCreator(tree, tree.basis_tree())
388
self.addCleanup(creator.finalize)
389
manager = tree.get_shelf_manager()
390
shelf_id, shelf_file = manager.new_shelf()
392
creator.write_shelf(shelf_file)
395
tree.commit('rev2', rev_id='rev2')
396
shelf_file = manager.read_shelf(1)
397
self.addCleanup(shelf_file.close)
398
unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
399
self.addCleanup(unshelver.finalize)
400
self.assertEqual('rev1', unshelver.base_tree.get_revision_id())
402
def test_unshelve_serialization(self):
403
tree = self.make_branch_and_tree('.')
404
self.build_tree_contents([('shelf', EMPTY_SHELF)])
405
shelf_file = open('shelf', 'rb')
406
self.addCleanup(shelf_file.close)
407
unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
409
def test_corrupt_shelf(self):
410
tree = self.make_branch_and_tree('.')
411
self.build_tree_contents([('shelf', EMPTY_SHELF.replace('metadata',
413
shelf_file = open('shelf', 'rb')
414
self.addCleanup(shelf_file.close)
415
e = self.assertRaises(errors.ShelfCorrupt,
416
shelf.Unshelver.from_tree_and_shelf, tree,
418
self.assertEqual('Shelf corrupt.', str(e))
421
class TestShelfManager(tests.TestCaseWithTransport):
423
def test_get_shelf_manager(self):
424
tree = self.make_branch_and_tree('.')
425
manager = tree.get_shelf_manager()
426
self.assertEqual(tree._transport.base + 'shelf/',
427
manager.transport.base)
429
def get_manager(self):
430
return self.make_branch_and_tree('.').get_shelf_manager()
432
def test_get_shelf_filename(self):
433
tree = self.make_branch_and_tree('.')
434
manager = tree.get_shelf_manager()
435
self.assertEqual('shelf-1', manager.get_shelf_filename(1))
437
def test_get_shelf_ids(self):
438
tree = self.make_branch_and_tree('.')
439
manager = tree.get_shelf_manager()
440
self.assertEqual([1, 3], manager.get_shelf_ids(
441
['shelf-1', 'shelf-02', 'shelf-3']))
443
def test_new_shelf(self):
444
manager = self.get_manager()
445
shelf_id, shelf_file = manager.new_shelf()
447
self.assertEqual(1, shelf_id)
448
shelf_id, shelf_file = manager.new_shelf()
450
self.assertEqual(2, shelf_id)
451
manager.delete_shelf(1)
452
shelf_id, shelf_file = manager.new_shelf()
454
self.assertEqual(3, shelf_id)
456
def test_active_shelves(self):
457
manager = self.get_manager()
458
self.assertEqual([], manager.active_shelves())
459
shelf_id, shelf_file = manager.new_shelf()
461
self.assertEqual([1], manager.active_shelves())
463
def test_delete_shelf(self):
464
manager = self.get_manager()
465
shelf_id, shelf_file = manager.new_shelf()
467
self.assertEqual([1], manager.active_shelves())
468
manager.delete_shelf(1)
469
self.assertEqual([], manager.active_shelves())
471
def test_last_shelf(self):
472
manager = self.get_manager()
473
self.assertIs(None, manager.last_shelf())
474
shelf_id, shelf_file = manager.new_shelf()
476
self.assertEqual(1, manager.last_shelf())
478
def test_read_shelf(self):
479
manager = self.get_manager()
480
shelf_id, shelf_file = manager.new_shelf()
482
shelf_file.write('foo')
485
shelf_id, shelf_file = manager.new_shelf()
487
shelf_file.write('bar')
490
shelf_file = manager.read_shelf(1)
492
self.assertEqual('foo', shelf_file.read())
495
shelf_file = manager.read_shelf(2)
497
self.assertEqual('bar', shelf_file.read())
501
def test_read_non_existant(self):
502
manager = self.get_manager()
503
e = self.assertRaises(errors.NoSuchShelfId, manager.read_shelf, 1)
504
self.assertEqual('No changes are shelved with id "1".', str(e))
506
def test_shelve_changes(self):
507
tree = self.make_branch_and_tree('tree')
508
tree.commit('no-change commit')
510
self.addCleanup(tree.unlock)
511
self.build_tree_contents([('tree/foo', 'bar')])
512
self.assertFileEqual('bar', 'tree/foo')
513
tree.add('foo', 'foo-id')
514
creator = shelf.ShelfCreator(tree, tree.basis_tree())
515
self.addCleanup(creator.finalize)
516
list(creator.iter_shelvable())
517
creator.shelve_creation('foo-id')
518
shelf_manager = tree.get_shelf_manager()
519
shelf_id = shelf_manager.shelve_changes(creator)
520
self.failIfExists('tree/foo')
521
unshelver = shelf_manager.get_unshelver(shelf_id)
522
unshelver.make_merger().do_merge()
523
self.assertFileEqual('bar', 'tree/foo')
525
def test_get_metadata(self):
526
tree = self.make_branch_and_tree('.')
527
creator = shelf.ShelfCreator(tree, tree.basis_tree())
528
shelf_manager = tree.get_shelf_manager()
529
shelf_id = shelf_manager.shelve_changes(creator, 'foo')
530
metadata = shelf_manager.get_metadata(shelf_id)
531
self.assertEqual('foo', metadata['message'])
532
self.assertEqual('null:', metadata['revision_id'])
added
removed
bzrlib/tests/test_shelf.py
