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
30
EMPTY_SHELF = ("Bazaar pack format 1 (introduced in 0.18)\n"
33
"d11:revision_id5:null:e"
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")
41
class TestPrepareShelf(tests.TestCaseWithTransport):
43
def test_shelve_rename(self):
44
tree = self.make_branch_and_tree('.')
45
self.build_tree(['foo'])
46
tree.add(['foo'], ['foo-id'])
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
creator.shelve_rename('foo-id')
54
work_trans_id = creator.work_transform.trans_id_file_id('foo-id')
55
self.assertEqual('foo', creator.work_transform.final_name(
57
shelf_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
58
self.assertEqual('bar', creator.shelf_transform.final_name(
61
def test_shelve_move(self):
62
tree = self.make_branch_and_tree('.')
63
self.build_tree(['foo/', 'bar/', 'foo/baz'])
64
tree.add(['foo', 'bar', 'foo/baz'], ['foo-id', 'bar-id', 'baz-id'])
66
tree.rename_one('foo/baz', 'bar/baz')
67
creator = shelf.ShelfCreator(tree, tree.basis_tree())
68
self.addCleanup(creator.finalize)
69
self.assertEqual([('rename', 'baz-id', 'foo/baz', 'bar/baz')],
70
list(creator.iter_shelvable()))
71
creator.shelve_rename('baz-id')
72
work_trans_id = creator.work_transform.trans_id_file_id('baz-id')
73
work_foo = creator.work_transform.trans_id_file_id('foo-id')
74
self.assertEqual(work_foo, creator.work_transform.final_parent(
76
shelf_trans_id = creator.shelf_transform.trans_id_file_id('baz-id')
77
shelf_bar = creator.shelf_transform.trans_id_file_id('bar-id')
78
self.assertEqual(shelf_bar, creator.shelf_transform.final_parent(
81
self.assertEqual('foo/baz', tree.id2path('baz-id'))
83
def assertShelvedFileEqual(self, expected_content, creator, file_id):
84
s_trans_id = creator.shelf_transform.trans_id_file_id(file_id)
85
shelf_file = creator.shelf_transform._limbo_name(s_trans_id)
86
self.assertFileEqual(expected_content, shelf_file)
88
def test_shelve_content_change(self):
89
tree = self.make_branch_and_tree('.')
91
self.addCleanup(tree.unlock)
92
self.build_tree_contents([('foo', 'a\n')])
93
tree.add('foo', 'foo-id')
94
tree.commit('Committed foo')
95
self.build_tree_contents([('foo', 'b\na\nc\n')])
96
creator = shelf.ShelfCreator(tree, tree.basis_tree())
97
self.addCleanup(creator.finalize)
98
self.assertEqual([('modify text', 'foo-id')],
99
list(creator.iter_shelvable()))
100
creator.shelve_lines('foo-id', ['a\n', 'c\n'])
102
self.assertFileEqual('a\nc\n', 'foo')
103
self.assertShelvedFileEqual('b\na\n', creator, 'foo-id')
105
def test_shelve_creation(self):
106
tree = self.make_branch_and_tree('.')
108
self.addCleanup(tree.unlock)
109
tree.commit('Empty tree')
110
self.build_tree_contents([('foo', 'a\n'), ('bar/',)])
111
tree.add(['foo', 'bar'], ['foo-id', 'bar-id'])
112
creator = shelf.ShelfCreator(tree, tree.basis_tree())
113
self.addCleanup(creator.finalize)
114
self.assertEqual([('add file', 'bar-id', 'directory', 'bar'),
115
('add file', 'foo-id', 'file', 'foo')],
116
sorted(list(creator.iter_shelvable())))
117
creator.shelve_creation('foo-id')
118
creator.shelve_creation('bar-id')
120
self.assertRaises(StopIteration,
121
tree.iter_entries_by_dir(['foo-id']).next)
122
s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
123
self.assertEqual('foo-id',
124
creator.shelf_transform.final_file_id(s_trans_id))
125
self.failIfExists('foo')
126
self.failIfExists('bar')
127
self.assertShelvedFileEqual('a\n', creator, 'foo-id')
128
s_bar_trans_id = creator.shelf_transform.trans_id_file_id('bar-id')
129
self.assertEqual('directory',
130
creator.shelf_transform.final_kind(s_bar_trans_id))
132
def test_shelve_symlink_creation(self):
133
self.requireFeature(tests.SymlinkFeature)
134
tree = self.make_branch_and_tree('.')
136
self.addCleanup(tree.unlock)
137
tree.commit('Empty tree')
138
os.symlink('bar', 'foo')
139
tree.add('foo', 'foo-id')
140
creator = shelf.ShelfCreator(tree, tree.basis_tree())
141
self.addCleanup(creator.finalize)
142
self.assertEqual([('add file', 'foo-id', 'symlink', 'foo')],
143
list(creator.iter_shelvable()))
144
creator.shelve_creation('foo-id')
146
s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
147
self.failIfExists('foo')
148
limbo_name = creator.shelf_transform._limbo_name(s_trans_id)
149
self.assertEqual('bar', os.readlink(limbo_name))
151
def test_shelve_symlink_target_change(self):
152
self.requireFeature(tests.SymlinkFeature)
153
tree = self.make_branch_and_tree('.')
155
self.addCleanup(tree.unlock)
156
os.symlink('bar', 'foo')
157
tree.add('foo', 'foo-id')
158
tree.commit("commit symlink")
160
os.symlink('baz', 'foo')
161
creator = shelf.ShelfCreator(tree, tree.basis_tree())
162
self.addCleanup(creator.finalize)
163
self.assertEqual([('modify target', 'foo-id', 'foo', 'bar', 'baz')],
164
list(creator.iter_shelvable()))
165
creator.shelve_modify_target('foo-id')
167
self.assertEqual('bar', os.readlink('foo'))
168
s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
169
limbo_name = creator.shelf_transform._limbo_name(s_trans_id)
170
self.assertEqual('baz', os.readlink(limbo_name))
172
def test_shelve_creation_no_contents(self):
173
tree = self.make_branch_and_tree('.')
175
self.addCleanup(tree.unlock)
176
tree.commit('Empty tree')
177
self.build_tree(['foo'])
178
tree.add('foo', 'foo-id')
180
creator = shelf.ShelfCreator(tree, tree.basis_tree())
181
self.addCleanup(creator.finalize)
182
self.assertEqual([('add file', 'foo-id', None, 'foo')],
183
sorted(list(creator.iter_shelvable())))
184
creator.shelve_creation('foo-id')
186
self.assertRaises(StopIteration,
187
tree.iter_entries_by_dir(['foo-id']).next)
188
self.assertShelvedFileEqual('', creator, 'foo-id')
189
s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
190
self.assertEqual('foo-id',
191
creator.shelf_transform.final_file_id(s_trans_id))
192
self.failIfExists('foo')
194
def test_shelve_deletion(self):
195
tree = self.make_branch_and_tree('tree')
197
self.addCleanup(tree.unlock)
198
self.build_tree_contents([('tree/foo/',), ('tree/foo/bar', 'baz')])
199
tree.add(['foo', 'foo/bar'], ['foo-id', 'bar-id'])
200
tree.commit('Added file and directory')
201
tree.unversion(['foo-id', 'bar-id'])
202
os.unlink('tree/foo/bar')
204
creator = shelf.ShelfCreator(tree, tree.basis_tree())
205
self.addCleanup(creator.finalize)
206
self.assertEqual([('delete file', 'bar-id', 'file', 'foo/bar'),
207
('delete file', 'foo-id', 'directory', 'foo')],
208
sorted(list(creator.iter_shelvable())))
209
creator.shelve_deletion('foo-id')
210
creator.shelve_deletion('bar-id')
212
self.assertTrue('foo-id' in tree)
213
self.assertTrue('bar-id' in tree)
214
self.assertFileEqual('baz', 'tree/foo/bar')
216
def test_shelve_delete_contents(self):
217
tree = self.make_branch_and_tree('tree')
218
self.build_tree(['tree/foo',])
219
tree.add('foo', 'foo-id')
220
tree.commit('Added file and directory')
221
os.unlink('tree/foo')
222
creator = shelf.ShelfCreator(tree, tree.basis_tree())
223
self.addCleanup(creator.finalize)
224
self.assertEqual([('delete file', 'foo-id', 'file', 'foo')],
225
sorted(list(creator.iter_shelvable())))
226
creator.shelve_deletion('foo-id')
228
self.failUnlessExists('tree/foo')
230
def test_shelve_change_kind(self):
231
tree = self.make_branch_and_tree('tree')
232
self.build_tree_contents([('tree/foo', 'bar')])
233
tree.add('foo', 'foo-id')
234
tree.commit('Added file and directory')
235
os.unlink('tree/foo')
237
creator = shelf.ShelfCreator(tree, tree.basis_tree())
238
self.addCleanup(creator.finalize)
239
self.assertEqual([('change kind', 'foo-id', 'file', 'directory',
240
'foo')], sorted(list(creator.iter_shelvable())))
241
creator.shelve_content_change('foo-id')
243
self.assertFileEqual('bar', 'tree/foo')
244
s_trans_id = creator.shelf_transform.trans_id_file_id('foo-id')
245
self.assertEqual('directory',
246
creator.shelf_transform._new_contents[s_trans_id])
248
def test_shelve_unversion(self):
249
tree = self.make_branch_and_tree('tree')
250
self.build_tree(['tree/foo',])
251
tree.add('foo', 'foo-id')
252
tree.commit('Added file and directory')
253
tree.unversion(['foo-id'])
254
creator = shelf.ShelfCreator(tree, tree.basis_tree())
255
self.addCleanup(creator.finalize)
256
self.assertEqual([('delete file', 'foo-id', 'file', 'foo')],
257
sorted(list(creator.iter_shelvable())))
258
creator.shelve_deletion('foo-id')
260
self.failUnlessExists('tree/foo')
262
def test_shelve_serialization(self):
263
tree = self.make_branch_and_tree('.')
264
creator = shelf.ShelfCreator(tree, tree.basis_tree())
265
self.addCleanup(creator.finalize)
266
shelf_file = open('shelf', 'wb')
267
self.addCleanup(shelf_file.close)
269
creator.write_shelf(shelf_file)
272
self.assertFileEqual(EMPTY_SHELF, 'shelf')
274
def test_write_shelf(self):
275
tree = self.make_branch_and_tree('tree')
276
self.build_tree(['tree/foo'])
277
tree.add('foo', 'foo-id')
278
creator = shelf.ShelfCreator(tree, tree.basis_tree())
279
self.addCleanup(creator.finalize)
280
list(creator.iter_shelvable())
281
creator.shelve_creation('foo-id')
282
shelf_file = open('shelf', 'wb')
284
creator.write_shelf(shelf_file)
287
parser = pack.ContainerPushParser()
288
shelf_file = open('shelf', 'rb')
290
parser.accept_bytes(shelf_file.read())
293
tt = transform.TransformPreview(tree)
294
self.addCleanup(tt.finalize)
295
records = iter(parser.read_pending_records())
298
tt.deserialize(records)
300
def test_shelve_unversioned(self):
301
tree = self.make_branch_and_tree('tree')
302
self.assertRaises(errors.PathsNotVersionedError,
303
shelf.ShelfCreator, tree, tree.basis_tree(), ['foo'])
304
# We should be able to lock/unlock the tree if ShelfCreator cleaned
306
wt = workingtree.WorkingTree.open('tree')
309
# And a second tentative should raise the same error (no
310
# limbo/pending_deletion leftovers).
311
self.assertRaises(errors.PathsNotVersionedError,
312
shelf.ShelfCreator, tree, tree.basis_tree(), ['foo'])
315
class TestUnshelver(tests.TestCaseWithTransport):
317
def test_make_merger(self):
318
tree = self.make_branch_and_tree('tree')
319
tree.commit('first commit')
320
self.build_tree_contents([('tree/foo', 'bar')])
322
self.addCleanup(tree.unlock)
323
tree.add('foo', 'foo-id')
324
creator = shelf.ShelfCreator(tree, tree.basis_tree())
325
self.addCleanup(creator.finalize)
326
list(creator.iter_shelvable())
327
creator.shelve_creation('foo-id')
328
shelf_file = open('shelf-file', 'w+b')
330
creator.write_shelf(shelf_file)
333
unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
334
unshelver.make_merger().do_merge()
335
self.assertFileEqual('bar', 'tree/foo')
339
def test_unshelve_changed(self):
340
tree = self.make_branch_and_tree('tree')
342
self.addCleanup(tree.unlock)
343
self.build_tree_contents([('tree/foo', 'a\nb\nc\n')])
344
tree.add('foo', 'foo-id')
345
tree.commit('first commit')
346
self.build_tree_contents([('tree/foo', 'a\nb\nd\n')])
347
creator = shelf.ShelfCreator(tree, tree.basis_tree())
348
self.addCleanup(creator.finalize)
349
list(creator.iter_shelvable())
350
creator.shelve_lines('foo-id', ['a\n', 'b\n', 'c\n'])
351
shelf_file = open('shelf', 'w+b')
352
self.addCleanup(shelf_file.close)
353
creator.write_shelf(shelf_file)
355
self.build_tree_contents([('tree/foo', 'z\na\nb\nc\n')])
357
unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
358
unshelver.make_merger().do_merge()
359
self.assertFileEqual('z\na\nb\nd\n', 'tree/foo')
361
def test_unshelve_deleted(self):
362
tree = self.make_branch_and_tree('tree')
364
self.addCleanup(tree.unlock)
365
self.build_tree_contents([('tree/foo/',), ('tree/foo/bar', 'baz')])
366
tree.add(['foo', 'foo/bar'], ['foo-id', 'bar-id'])
367
tree.commit('Added file and directory')
368
tree.unversion(['foo-id', 'bar-id'])
369
os.unlink('tree/foo/bar')
371
creator = shelf.ShelfCreator(tree, tree.basis_tree())
372
list(creator.iter_shelvable())
373
creator.shelve_deletion('foo-id')
374
creator.shelve_deletion('bar-id')
375
shelf_file = open('shelf', 'w+b')
376
self.addCleanup(shelf_file.close)
377
creator.write_shelf(shelf_file)
380
# validate the test setup
381
self.assertTrue('foo-id' in tree)
382
self.assertTrue('bar-id' in tree)
383
self.assertFileEqual('baz', 'tree/foo/bar')
385
unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
386
unshelver.make_merger().do_merge()
387
self.assertFalse('foo-id' in tree)
388
self.assertFalse('bar-id' in tree)
390
def test_unshelve_base(self):
391
tree = self.make_branch_and_tree('tree')
393
self.addCleanup(tree.unlock)
394
tree.commit('rev1', rev_id='rev1')
395
creator = shelf.ShelfCreator(tree, tree.basis_tree())
396
self.addCleanup(creator.finalize)
397
manager = tree.get_shelf_manager()
398
shelf_id, shelf_file = manager.new_shelf()
400
creator.write_shelf(shelf_file)
403
tree.commit('rev2', rev_id='rev2')
404
shelf_file = manager.read_shelf(1)
405
self.addCleanup(shelf_file.close)
406
unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
407
self.addCleanup(unshelver.finalize)
408
self.assertEqual('rev1', unshelver.base_tree.get_revision_id())
410
def test_unshelve_serialization(self):
411
tree = self.make_branch_and_tree('.')
412
self.build_tree_contents([('shelf', EMPTY_SHELF)])
413
shelf_file = open('shelf', 'rb')
414
self.addCleanup(shelf_file.close)
415
unshelver = shelf.Unshelver.from_tree_and_shelf(tree, shelf_file)
417
def test_corrupt_shelf(self):
418
tree = self.make_branch_and_tree('.')
419
self.build_tree_contents([('shelf', EMPTY_SHELF.replace('metadata',
421
shelf_file = open('shelf', 'rb')
422
self.addCleanup(shelf_file.close)
423
e = self.assertRaises(errors.ShelfCorrupt,
424
shelf.Unshelver.from_tree_and_shelf, tree,
426
self.assertEqual('Shelf corrupt.', str(e))
429
class TestShelfManager(tests.TestCaseWithTransport):
431
def test_get_shelf_manager(self):
432
tree = self.make_branch_and_tree('.')
433
manager = tree.get_shelf_manager()
434
self.assertEqual(tree._transport.base + 'shelf/',
435
manager.transport.base)
437
def get_manager(self):
438
return self.make_branch_and_tree('.').get_shelf_manager()
440
def test_get_shelf_filename(self):
441
tree = self.make_branch_and_tree('.')
442
manager = tree.get_shelf_manager()
443
self.assertEqual('shelf-1', manager.get_shelf_filename(1))
445
def test_get_shelf_ids(self):
446
tree = self.make_branch_and_tree('.')
447
manager = tree.get_shelf_manager()
448
self.assertEqual([1, 3], manager.get_shelf_ids(
449
['shelf-1', 'shelf-02', 'shelf-3']))
451
def test_new_shelf(self):
452
manager = self.get_manager()
453
shelf_id, shelf_file = manager.new_shelf()
455
self.assertEqual(1, shelf_id)
456
shelf_id, shelf_file = manager.new_shelf()
458
self.assertEqual(2, shelf_id)
459
manager.delete_shelf(1)
460
shelf_id, shelf_file = manager.new_shelf()
462
self.assertEqual(3, shelf_id)
464
def test_active_shelves(self):
465
manager = self.get_manager()
466
self.assertEqual([], manager.active_shelves())
467
shelf_id, shelf_file = manager.new_shelf()
469
self.assertEqual([1], manager.active_shelves())
471
def test_delete_shelf(self):
472
manager = self.get_manager()
473
shelf_id, shelf_file = manager.new_shelf()
475
self.assertEqual([1], manager.active_shelves())
476
manager.delete_shelf(1)
477
self.assertEqual([], manager.active_shelves())
479
def test_last_shelf(self):
480
manager = self.get_manager()
481
self.assertIs(None, manager.last_shelf())
482
shelf_id, shelf_file = manager.new_shelf()
484
self.assertEqual(1, manager.last_shelf())
486
def test_read_shelf(self):
487
manager = self.get_manager()
488
shelf_id, shelf_file = manager.new_shelf()
490
shelf_file.write('foo')
493
shelf_id, shelf_file = manager.new_shelf()
495
shelf_file.write('bar')
498
shelf_file = manager.read_shelf(1)
500
self.assertEqual('foo', shelf_file.read())
503
shelf_file = manager.read_shelf(2)
505
self.assertEqual('bar', shelf_file.read())
509
def test_read_non_existant(self):
510
manager = self.get_manager()
511
e = self.assertRaises(errors.NoSuchShelfId, manager.read_shelf, 1)
512
self.assertEqual('No changes are shelved with id "1".', str(e))
514
def test_shelve_changes(self):
515
tree = self.make_branch_and_tree('tree')
516
tree.commit('no-change commit')
518
self.addCleanup(tree.unlock)
519
self.build_tree_contents([('tree/foo', 'bar')])
520
self.assertFileEqual('bar', 'tree/foo')
521
tree.add('foo', 'foo-id')
522
creator = shelf.ShelfCreator(tree, tree.basis_tree())
523
self.addCleanup(creator.finalize)
524
list(creator.iter_shelvable())
525
creator.shelve_creation('foo-id')
526
shelf_manager = tree.get_shelf_manager()
527
shelf_id = shelf_manager.shelve_changes(creator)
528
self.failIfExists('tree/foo')
529
unshelver = shelf_manager.get_unshelver(shelf_id)
530
unshelver.make_merger().do_merge()
531
self.assertFileEqual('bar', 'tree/foo')
533
def test_get_metadata(self):
534
tree = self.make_branch_and_tree('.')
535
creator = shelf.ShelfCreator(tree, tree.basis_tree())
536
shelf_manager = tree.get_shelf_manager()
537
shelf_id = shelf_manager.shelve_changes(creator, 'foo')
538
metadata = shelf_manager.get_metadata(shelf_id)
539
self.assertEqual('foo', metadata['message'])
540
self.assertEqual('null:', metadata['revision_id'])