1
# Copyright (C) 2008, 2009, 2010 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
18
from cStringIO import StringIO
21
from textwrap import dedent
29
from bzrlib.tests import script
32
class ExpectShelver(shelf_ui.Shelver):
33
"""A variant of Shelver that intercepts console activity, for testing."""
35
def __init__(self, work_tree, target_tree, diff_writer=None,
36
auto=False, auto_apply=False, file_list=None, message=None,
37
destroy=False, reporter=None):
38
shelf_ui.Shelver.__init__(self, work_tree, target_tree, diff_writer,
39
auto, auto_apply, file_list, message,
40
destroy, reporter=reporter)
42
self.diff_writer = StringIO()
44
def expect(self, prompt, response):
45
self.expected.append((prompt, response))
47
def prompt(self, message):
49
prompt, response = self.expected.pop(0)
51
raise AssertionError('Unexpected prompt: %s' % message)
53
raise AssertionError('Wrong prompt: %s' % message)
57
LINES_AJ = 'a\nb\nc\nd\ne\nf\ng\nh\ni\nj\n'
60
LINES_ZY = 'z\nb\nc\nd\ne\nf\ng\nh\ni\ny\n'
63
LINES_AY = 'a\nb\nc\nd\ne\nf\ng\nh\ni\ny\n'
66
class ShelfTestCase(tests.TestCaseWithTransport):
68
def create_shelvable_tree(self):
69
tree = self.make_branch_and_tree('tree')
70
self.build_tree_contents([('tree/foo', LINES_AJ)])
71
tree.add('foo', 'foo-id')
72
tree.commit('added foo')
73
self.build_tree_contents([('tree/foo', LINES_ZY)])
77
class TestShelver(ShelfTestCase):
79
def test_unexpected_prompt_failure(self):
80
tree = self.create_shelvable_tree()
81
tree.lock_tree_write()
82
self.addCleanup(tree.unlock)
83
shelver = ExpectShelver(tree, tree.basis_tree())
84
self.addCleanup(shelver.finalize)
85
e = self.assertRaises(AssertionError, shelver.run)
86
self.assertEqual('Unexpected prompt: Shelve? [yNfq?]', str(e))
88
def test_wrong_prompt_failure(self):
89
tree = self.create_shelvable_tree()
90
tree.lock_tree_write()
91
self.addCleanup(tree.unlock)
92
shelver = ExpectShelver(tree, tree.basis_tree())
93
self.addCleanup(shelver.finalize)
94
shelver.expect('foo', 'y')
95
e = self.assertRaises(AssertionError, shelver.run)
96
self.assertEqual('Wrong prompt: Shelve? [yNfq?]', str(e))
98
def test_shelve_not_diff(self):
99
tree = self.create_shelvable_tree()
100
tree.lock_tree_write()
101
self.addCleanup(tree.unlock)
102
shelver = ExpectShelver(tree, tree.basis_tree())
103
self.addCleanup(shelver.finalize)
104
shelver.expect('Shelve? [yNfq?]', 'n')
105
shelver.expect('Shelve? [yNfq?]', 'n')
106
# No final shelving prompt because no changes were selected
108
self.assertFileEqual(LINES_ZY, 'tree/foo')
110
def test_shelve_diff_no(self):
111
tree = self.create_shelvable_tree()
112
tree.lock_tree_write()
113
self.addCleanup(tree.unlock)
114
shelver = ExpectShelver(tree, tree.basis_tree())
115
self.addCleanup(shelver.finalize)
116
shelver.expect('Shelve? [yNfq?]', 'y')
117
shelver.expect('Shelve? [yNfq?]', 'y')
118
shelver.expect('Shelve 2 change(s)? [yNfq?]', 'n')
120
self.assertFileEqual(LINES_ZY, 'tree/foo')
122
def test_shelve_diff(self):
123
tree = self.create_shelvable_tree()
124
tree.lock_tree_write()
125
self.addCleanup(tree.unlock)
126
shelver = ExpectShelver(tree, tree.basis_tree())
127
self.addCleanup(shelver.finalize)
128
shelver.expect('Shelve? [yNfq?]', 'y')
129
shelver.expect('Shelve? [yNfq?]', 'y')
130
shelver.expect('Shelve 2 change(s)? [yNfq?]', 'y')
132
self.assertFileEqual(LINES_AJ, 'tree/foo')
134
def test_shelve_one_diff(self):
135
tree = self.create_shelvable_tree()
136
tree.lock_tree_write()
137
self.addCleanup(tree.unlock)
138
shelver = ExpectShelver(tree, tree.basis_tree())
139
self.addCleanup(shelver.finalize)
140
shelver.expect('Shelve? [yNfq?]', 'y')
141
shelver.expect('Shelve? [yNfq?]', 'n')
142
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
144
self.assertFileEqual(LINES_AY, 'tree/foo')
146
def test_shelve_binary_change(self):
147
tree = self.create_shelvable_tree()
148
self.build_tree_contents([('tree/foo', '\x00')])
149
tree.lock_tree_write()
150
self.addCleanup(tree.unlock)
151
shelver = ExpectShelver(tree, tree.basis_tree())
152
self.addCleanup(shelver.finalize)
153
shelver.expect('Shelve binary changes? [yNfq?]', 'y')
154
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
156
self.assertFileEqual(LINES_AJ, 'tree/foo')
158
def test_shelve_rename(self):
159
tree = self.create_shelvable_tree()
160
tree.rename_one('foo', 'bar')
161
tree.lock_tree_write()
162
self.addCleanup(tree.unlock)
163
shelver = ExpectShelver(tree, tree.basis_tree())
164
self.addCleanup(shelver.finalize)
165
shelver.expect('Shelve renaming "foo" => "bar"? [yNfq?]', 'y')
166
shelver.expect('Shelve? [yNfq?]', 'y')
167
shelver.expect('Shelve? [yNfq?]', 'y')
168
shelver.expect('Shelve 3 change(s)? [yNfq?]', 'y')
170
self.assertFileEqual(LINES_AJ, 'tree/foo')
172
def test_shelve_deletion(self):
173
tree = self.create_shelvable_tree()
174
os.unlink('tree/foo')
175
tree.lock_tree_write()
176
self.addCleanup(tree.unlock)
177
shelver = ExpectShelver(tree, tree.basis_tree())
178
self.addCleanup(shelver.finalize)
179
shelver.expect('Shelve removing file "foo"? [yNfq?]', 'y')
180
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
182
self.assertFileEqual(LINES_AJ, 'tree/foo')
184
def test_shelve_creation(self):
185
tree = self.make_branch_and_tree('tree')
186
tree.commit('add tree root')
187
self.build_tree(['tree/foo'])
189
tree.lock_tree_write()
190
self.addCleanup(tree.unlock)
191
shelver = ExpectShelver(tree, tree.basis_tree())
192
self.addCleanup(shelver.finalize)
193
shelver.expect('Shelve adding file "foo"? [yNfq?]', 'y')
194
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
196
self.assertPathDoesNotExist('tree/foo')
198
def test_shelve_kind_change(self):
199
tree = self.create_shelvable_tree()
200
os.unlink('tree/foo')
202
tree.lock_tree_write()
203
self.addCleanup(tree.unlock)
204
shelver = ExpectShelver(tree, tree.basis_tree())
205
self.addCleanup(shelver.finalize)
206
shelver.expect('Shelve changing "foo" from file to directory? [yNfq?]',
208
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
210
def test_shelve_modify_target(self):
211
self.requireFeature(tests.SymlinkFeature)
212
tree = self.create_shelvable_tree()
213
os.symlink('bar', 'tree/baz')
214
tree.add('baz', 'baz-id')
215
tree.commit("Add symlink")
216
os.unlink('tree/baz')
217
os.symlink('vax', 'tree/baz')
218
tree.lock_tree_write()
219
self.addCleanup(tree.unlock)
220
shelver = ExpectShelver(tree, tree.basis_tree())
221
self.addCleanup(shelver.finalize)
222
shelver.expect('Shelve changing target of "baz" from "bar" to '
223
'"vax"? [yNfq?]', 'y')
224
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
226
self.assertEqual('bar', os.readlink('tree/baz'))
228
def test_shelve_finish(self):
229
tree = self.create_shelvable_tree()
230
tree.lock_tree_write()
231
self.addCleanup(tree.unlock)
232
shelver = ExpectShelver(tree, tree.basis_tree())
233
self.addCleanup(shelver.finalize)
234
shelver.expect('Shelve? [yNfq?]', 'f')
235
shelver.expect('Shelve 2 change(s)? [yNfq?]', 'y')
237
self.assertFileEqual(LINES_AJ, 'tree/foo')
239
def test_shelve_quit(self):
240
tree = self.create_shelvable_tree()
241
tree.lock_tree_write()
242
self.addCleanup(tree.unlock)
243
shelver = ExpectShelver(tree, tree.basis_tree())
244
self.addCleanup(shelver.finalize)
245
shelver.expect('Shelve? [yNfq?]', 'q')
246
self.assertRaises(errors.UserAbort, shelver.run)
247
self.assertFileEqual(LINES_ZY, 'tree/foo')
249
def test_shelve_all(self):
250
tree = self.create_shelvable_tree()
251
shelver = ExpectShelver.from_args(sys.stdout, all=True,
257
self.assertFileEqual(LINES_AJ, 'tree/foo')
259
def test_shelve_filename(self):
260
tree = self.create_shelvable_tree()
261
self.build_tree(['tree/bar'])
263
tree.lock_tree_write()
264
self.addCleanup(tree.unlock)
265
shelver = ExpectShelver(tree, tree.basis_tree(), file_list=['bar'])
266
self.addCleanup(shelver.finalize)
267
shelver.expect('Shelve adding file "bar"? [yNfq?]', 'y')
268
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
271
def test_shelve_help(self):
272
tree = self.create_shelvable_tree()
273
tree.lock_tree_write()
274
self.addCleanup(tree.unlock)
275
shelver = ExpectShelver(tree, tree.basis_tree())
276
self.addCleanup(shelver.finalize)
277
shelver.expect('Shelve? [yNfq?]', '?')
278
shelver.expect('Shelve? [(y)es, (N)o, (f)inish, or (q)uit]', 'f')
279
shelver.expect('Shelve 2 change(s)? [yNfq?]', 'y')
282
def test_shelve_destroy(self):
283
tree = self.create_shelvable_tree()
284
shelver = shelf_ui.Shelver.from_args(sys.stdout, all=True,
285
directory='tree', destroy=True)
286
self.addCleanup(shelver.finalize)
288
self.assertIs(None, tree.get_shelf_manager().last_shelf())
289
self.assertFileEqual(LINES_AJ, 'tree/foo')
292
def shelve_all(tree, target_revision_id):
295
target = tree.branch.repository.revision_tree(target_revision_id)
296
shelver = shelf_ui.Shelver(tree, target, auto=True,
305
def test_shelve_old_root_deleted(self):
306
tree1 = self.make_branch_and_tree('tree1')
307
tree1.commit('add root')
308
tree2 = self.make_branch_and_tree('tree2')
309
rev2 = tree2.commit('add root')
310
tree1.merge_from_branch(tree2.branch,
311
from_revision=revision.NULL_REVISION)
312
tree1.commit('Replaced root entry')
313
# This is essentially assertNotRaises(InconsistentDelta)
314
# With testtools 0.99, it can be rewritten as:
315
# with ExpectedException(AssertionError,
316
# 'InconsistentDelta not raised'):
317
# with ExpectedException(errors.InconsistentDelta, ''):
318
# self.shelve_all(tree1, rev2)
319
e = self.assertRaises(AssertionError, self.assertRaises,
320
errors.InconsistentDelta, self.shelve_all, tree1,
322
self.assertContainsRe('InconsistentDelta not raised', str(e))
324
def test_shelve_split(self):
325
outer_tree = self.make_branch_and_tree('outer')
326
outer_tree.commit('Add root')
327
inner_tree = self.make_branch_and_tree('outer/inner')
328
rev2 = inner_tree.commit('Add root')
329
outer_tree.subsume(inner_tree)
330
# This is essentially assertNotRaises(ValueError).
331
# The ValueError is 'None is not a valid file id'.
332
self.expectFailure('Cannot shelve a join back to the inner tree.',
333
self.assertRaises, AssertionError,
334
self.assertRaises, ValueError, self.shelve_all,
338
class TestApplyReporter(ShelfTestCase):
340
def test_shelve_not_diff(self):
341
tree = self.create_shelvable_tree()
342
tree.lock_tree_write()
343
self.addCleanup(tree.unlock)
344
shelver = ExpectShelver(tree, tree.basis_tree(),
345
reporter=shelf_ui.ApplyReporter())
346
self.addCleanup(shelver.finalize)
347
shelver.expect('Apply change? [yNfq?]', 'n')
348
shelver.expect('Apply change? [yNfq?]', 'n')
349
# No final shelving prompt because no changes were selected
351
self.assertFileEqual(LINES_ZY, 'tree/foo')
353
def test_shelve_diff_no(self):
354
tree = self.create_shelvable_tree()
355
tree.lock_tree_write()
356
self.addCleanup(tree.unlock)
357
shelver = ExpectShelver(tree, tree.basis_tree(),
358
reporter=shelf_ui.ApplyReporter())
359
self.addCleanup(shelver.finalize)
360
shelver.expect('Apply change? [yNfq?]', 'y')
361
shelver.expect('Apply change? [yNfq?]', 'y')
362
shelver.expect('Apply 2 change(s)? [yNfq?]', 'n')
364
self.assertFileEqual(LINES_ZY, 'tree/foo')
366
def test_shelve_diff(self):
367
tree = self.create_shelvable_tree()
368
tree.lock_tree_write()
369
self.addCleanup(tree.unlock)
370
shelver = ExpectShelver(tree, tree.basis_tree(),
371
reporter=shelf_ui.ApplyReporter())
372
self.addCleanup(shelver.finalize)
373
shelver.expect('Apply change? [yNfq?]', 'y')
374
shelver.expect('Apply change? [yNfq?]', 'y')
375
shelver.expect('Apply 2 change(s)? [yNfq?]', 'y')
377
self.assertFileEqual(LINES_AJ, 'tree/foo')
379
def test_shelve_binary_change(self):
380
tree = self.create_shelvable_tree()
381
self.build_tree_contents([('tree/foo', '\x00')])
382
tree.lock_tree_write()
383
self.addCleanup(tree.unlock)
384
shelver = ExpectShelver(tree, tree.basis_tree(),
385
reporter=shelf_ui.ApplyReporter())
386
self.addCleanup(shelver.finalize)
387
shelver.expect('Apply binary changes? [yNfq?]', 'y')
388
shelver.expect('Apply 1 change(s)? [yNfq?]', 'y')
390
self.assertFileEqual(LINES_AJ, 'tree/foo')
392
def test_shelve_rename(self):
393
tree = self.create_shelvable_tree()
394
tree.rename_one('foo', 'bar')
395
tree.lock_tree_write()
396
self.addCleanup(tree.unlock)
397
shelver = ExpectShelver(tree, tree.basis_tree(),
398
reporter=shelf_ui.ApplyReporter())
399
self.addCleanup(shelver.finalize)
400
shelver.expect('Rename "bar" => "foo"? [yNfq?]', 'y')
401
shelver.expect('Apply change? [yNfq?]', 'y')
402
shelver.expect('Apply change? [yNfq?]', 'y')
403
shelver.expect('Apply 3 change(s)? [yNfq?]', 'y')
405
self.assertFileEqual(LINES_AJ, 'tree/foo')
407
def test_shelve_deletion(self):
408
tree = self.create_shelvable_tree()
409
os.unlink('tree/foo')
410
tree.lock_tree_write()
411
self.addCleanup(tree.unlock)
412
shelver = ExpectShelver(tree, tree.basis_tree(),
413
reporter=shelf_ui.ApplyReporter())
414
self.addCleanup(shelver.finalize)
415
shelver.expect('Add file "foo"? [yNfq?]', 'y')
416
shelver.expect('Apply 1 change(s)? [yNfq?]', 'y')
418
self.assertFileEqual(LINES_AJ, 'tree/foo')
420
def test_shelve_creation(self):
421
tree = self.make_branch_and_tree('tree')
422
tree.commit('add tree root')
423
self.build_tree(['tree/foo'])
425
tree.lock_tree_write()
426
self.addCleanup(tree.unlock)
427
shelver = ExpectShelver(tree, tree.basis_tree(),
428
reporter=shelf_ui.ApplyReporter())
429
self.addCleanup(shelver.finalize)
430
shelver.expect('Delete file "foo"? [yNfq?]', 'y')
431
shelver.expect('Apply 1 change(s)? [yNfq?]', 'y')
433
self.assertPathDoesNotExist('tree/foo')
435
def test_shelve_kind_change(self):
436
tree = self.create_shelvable_tree()
437
os.unlink('tree/foo')
439
tree.lock_tree_write()
440
self.addCleanup(tree.unlock)
441
shelver = ExpectShelver(tree, tree.basis_tree(),
442
reporter=shelf_ui.ApplyReporter())
443
self.addCleanup(shelver.finalize)
444
shelver.expect('Change "foo" from directory to a file? [yNfq?]', 'y')
445
shelver.expect('Apply 1 change(s)? [yNfq?]', 'y')
447
def test_shelve_modify_target(self):
448
self.requireFeature(tests.SymlinkFeature)
449
tree = self.create_shelvable_tree()
450
os.symlink('bar', 'tree/baz')
451
tree.add('baz', 'baz-id')
452
tree.commit("Add symlink")
453
os.unlink('tree/baz')
454
os.symlink('vax', 'tree/baz')
455
tree.lock_tree_write()
456
self.addCleanup(tree.unlock)
457
shelver = ExpectShelver(tree, tree.basis_tree(),
458
reporter=shelf_ui.ApplyReporter())
459
self.addCleanup(shelver.finalize)
460
shelver.expect('Change target of "baz" from "vax" to "bar"? [yNfq?]',
462
shelver.expect('Apply 1 change(s)? [yNfq?]', 'y')
464
self.assertEqual('bar', os.readlink('tree/baz'))
467
class TestUnshelver(tests.TestCaseWithTransport):
469
def create_tree_with_shelf(self):
470
tree = self.make_branch_and_tree('tree')
473
self.build_tree_contents([('tree/foo', LINES_AJ)])
474
tree.add('foo', 'foo-id')
475
tree.commit('added foo')
476
self.build_tree_contents([('tree/foo', LINES_ZY)])
477
shelver = shelf_ui.Shelver(tree, tree.basis_tree(),
478
auto_apply=True, auto=True)
487
def test_unshelve(self):
488
tree = self.create_tree_with_shelf()
490
self.addCleanup(tree.unlock)
491
manager = tree.get_shelf_manager()
492
shelf_ui.Unshelver(tree, manager, 1, True, True, True).run()
493
self.assertFileEqual(LINES_ZY, 'tree/foo')
495
def test_unshelve_args(self):
496
tree = self.create_tree_with_shelf()
497
unshelver = shelf_ui.Unshelver.from_args(directory='tree')
501
unshelver.tree.unlock()
502
self.assertFileEqual(LINES_ZY, 'tree/foo')
503
self.assertIs(None, tree.get_shelf_manager().last_shelf())
505
def test_unshelve_args_dry_run(self):
506
tree = self.create_tree_with_shelf()
507
unshelver = shelf_ui.Unshelver.from_args(directory='tree',
512
unshelver.tree.unlock()
513
self.assertFileEqual(LINES_AJ, 'tree/foo')
514
self.assertEqual(1, tree.get_shelf_manager().last_shelf())
516
def test_unshelve_args_preview(self):
517
tree = self.create_tree_with_shelf()
518
write_diff_to = StringIO()
519
unshelver = shelf_ui.Unshelver.from_args(
520
directory='tree', action='preview', write_diff_to=write_diff_to)
524
unshelver.tree.unlock()
525
# The changes were not unshelved.
526
self.assertFileEqual(LINES_AJ, 'tree/foo')
527
self.assertEqual(1, tree.get_shelf_manager().last_shelf())
529
# But the diff was written to write_diff_to.
530
diff = write_diff_to.getvalue()
531
expected = dedent("""\
546
self.assertEqualDiff(expected, diff[-len(expected):])
548
def test_unshelve_args_delete_only(self):
549
tree = self.make_branch_and_tree('tree')
550
manager = tree.get_shelf_manager()
551
shelf_file = manager.new_shelf()[1]
553
shelf_file.write('garbage')
556
unshelver = shelf_ui.Unshelver.from_args(directory='tree',
557
action='delete-only')
561
unshelver.tree.unlock()
562
self.assertIs(None, manager.last_shelf())
564
def test_unshelve_args_invalid_shelf_id(self):
565
tree = self.make_branch_and_tree('tree')
566
manager = tree.get_shelf_manager()
567
shelf_file = manager.new_shelf()[1]
569
shelf_file.write('garbage')
572
self.assertRaises(errors.InvalidShelfId,
573
shelf_ui.Unshelver.from_args, directory='tree',
574
action='delete-only', shelf_id='foo')
577
class TestUnshelveScripts(TestUnshelver,
578
script.TestCaseWithTransportAndScript):
580
def test_unshelve_messages_keep(self):
581
self.create_tree_with_shelf()
584
$ bzr unshelve --keep
585
2>Using changes with id "1".
587
2>All changes applied successfully.
590
def test_unshelve_messages_delete(self):
591
self.create_tree_with_shelf()
594
$ bzr unshelve --delete-only
595
2>Deleted changes with id "1".
598
def test_unshelve_messages_apply(self):
599
self.create_tree_with_shelf()
602
$ bzr unshelve --apply
603
2>Using changes with id "1".
605
2>All changes applied successfully.
606
2>Deleted changes with id "1".
609
def test_unshelve_messages_dry_run(self):
610
self.create_tree_with_shelf()
613
$ bzr unshelve --dry-run
614
2>Using changes with id "1".