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 TestShelver(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)])
76
def test_unexpected_prompt_failure(self):
77
tree = self.create_shelvable_tree()
78
tree.lock_tree_write()
79
self.addCleanup(tree.unlock)
80
shelver = ExpectShelver(tree, tree.basis_tree())
81
self.addCleanup(shelver.finalize)
82
e = self.assertRaises(AssertionError, shelver.run)
83
self.assertEqual('Unexpected prompt: Shelve? [yNfq?]', str(e))
85
def test_wrong_prompt_failure(self):
86
tree = self.create_shelvable_tree()
87
tree.lock_tree_write()
88
self.addCleanup(tree.unlock)
89
shelver = ExpectShelver(tree, tree.basis_tree())
90
self.addCleanup(shelver.finalize)
91
shelver.expect('foo', 'y')
92
e = self.assertRaises(AssertionError, shelver.run)
93
self.assertEqual('Wrong prompt: Shelve? [yNfq?]', str(e))
95
def test_shelve_not_diff(self):
96
tree = self.create_shelvable_tree()
97
tree.lock_tree_write()
98
self.addCleanup(tree.unlock)
99
shelver = ExpectShelver(tree, tree.basis_tree())
100
self.addCleanup(shelver.finalize)
101
shelver.expect('Shelve? [yNfq?]', 'n')
102
shelver.expect('Shelve? [yNfq?]', 'n')
103
# No final shelving prompt because no changes were selected
105
self.assertFileEqual(LINES_ZY, 'tree/foo')
107
def test_shelve_diff_no(self):
108
tree = self.create_shelvable_tree()
109
tree.lock_tree_write()
110
self.addCleanup(tree.unlock)
111
shelver = ExpectShelver(tree, tree.basis_tree())
112
self.addCleanup(shelver.finalize)
113
shelver.expect('Shelve? [yNfq?]', 'y')
114
shelver.expect('Shelve? [yNfq?]', 'y')
115
shelver.expect('Shelve 2 change(s)? [yNfq?]', 'n')
117
self.assertFileEqual(LINES_ZY, 'tree/foo')
119
def test_shelve_diff(self):
120
tree = self.create_shelvable_tree()
121
tree.lock_tree_write()
122
self.addCleanup(tree.unlock)
123
shelver = ExpectShelver(tree, tree.basis_tree())
124
self.addCleanup(shelver.finalize)
125
shelver.expect('Shelve? [yNfq?]', 'y')
126
shelver.expect('Shelve? [yNfq?]', 'y')
127
shelver.expect('Shelve 2 change(s)? [yNfq?]', 'y')
129
self.assertFileEqual(LINES_AJ, 'tree/foo')
131
def test_shelve_one_diff(self):
132
tree = self.create_shelvable_tree()
133
tree.lock_tree_write()
134
self.addCleanup(tree.unlock)
135
shelver = ExpectShelver(tree, tree.basis_tree())
136
self.addCleanup(shelver.finalize)
137
shelver.expect('Shelve? [yNfq?]', 'y')
138
shelver.expect('Shelve? [yNfq?]', 'n')
139
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
141
self.assertFileEqual(LINES_AY, 'tree/foo')
143
def test_shelve_binary_change(self):
144
tree = self.create_shelvable_tree()
145
self.build_tree_contents([('tree/foo', '\x00')])
146
tree.lock_tree_write()
147
self.addCleanup(tree.unlock)
148
shelver = ExpectShelver(tree, tree.basis_tree())
149
self.addCleanup(shelver.finalize)
150
shelver.expect('Shelve binary changes? [yNfq?]', 'y')
151
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
153
self.assertFileEqual(LINES_AJ, 'tree/foo')
155
def test_shelve_rename(self):
156
tree = self.create_shelvable_tree()
157
tree.rename_one('foo', 'bar')
158
tree.lock_tree_write()
159
self.addCleanup(tree.unlock)
160
shelver = ExpectShelver(tree, tree.basis_tree())
161
self.addCleanup(shelver.finalize)
162
shelver.expect('Shelve renaming "foo" => "bar"? [yNfq?]', 'y')
163
shelver.expect('Shelve? [yNfq?]', 'y')
164
shelver.expect('Shelve? [yNfq?]', 'y')
165
shelver.expect('Shelve 3 change(s)? [yNfq?]', 'y')
167
self.assertFileEqual(LINES_AJ, 'tree/foo')
169
def test_shelve_deletion(self):
170
tree = self.create_shelvable_tree()
171
os.unlink('tree/foo')
172
tree.lock_tree_write()
173
self.addCleanup(tree.unlock)
174
shelver = ExpectShelver(tree, tree.basis_tree())
175
self.addCleanup(shelver.finalize)
176
shelver.expect('Shelve removing file "foo"? [yNfq?]', 'y')
177
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
179
self.assertFileEqual(LINES_AJ, 'tree/foo')
181
def test_shelve_creation(self):
182
tree = self.make_branch_and_tree('tree')
183
tree.commit('add tree root')
184
self.build_tree(['tree/foo'])
186
tree.lock_tree_write()
187
self.addCleanup(tree.unlock)
188
shelver = ExpectShelver(tree, tree.basis_tree())
189
self.addCleanup(shelver.finalize)
190
shelver.expect('Shelve adding file "foo"? [yNfq?]', 'y')
191
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
193
self.failIfExists('tree/foo')
195
def test_shelve_kind_change(self):
196
tree = self.create_shelvable_tree()
197
os.unlink('tree/foo')
199
tree.lock_tree_write()
200
self.addCleanup(tree.unlock)
201
shelver = ExpectShelver(tree, tree.basis_tree())
202
self.addCleanup(shelver.finalize)
203
shelver.expect('Shelve changing "foo" from file to directory? [yNfq?]',
205
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
207
def test_shelve_modify_target(self):
208
self.requireFeature(tests.SymlinkFeature)
209
tree = self.create_shelvable_tree()
210
os.symlink('bar', 'tree/baz')
211
tree.add('baz', 'baz-id')
212
tree.commit("Add symlink")
213
os.unlink('tree/baz')
214
os.symlink('vax', 'tree/baz')
215
tree.lock_tree_write()
216
self.addCleanup(tree.unlock)
217
shelver = ExpectShelver(tree, tree.basis_tree())
218
self.addCleanup(shelver.finalize)
219
shelver.expect('Shelve changing target of "baz" from "bar" to '
220
'"vax"? [yNfq?]', 'y')
221
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
223
self.assertEqual('bar', os.readlink('tree/baz'))
225
def test_shelve_finish(self):
226
tree = self.create_shelvable_tree()
227
tree.lock_tree_write()
228
self.addCleanup(tree.unlock)
229
shelver = ExpectShelver(tree, tree.basis_tree())
230
self.addCleanup(shelver.finalize)
231
shelver.expect('Shelve? [yNfq?]', 'f')
232
shelver.expect('Shelve 2 change(s)? [yNfq?]', 'y')
234
self.assertFileEqual(LINES_AJ, 'tree/foo')
236
def test_shelve_quit(self):
237
tree = self.create_shelvable_tree()
238
tree.lock_tree_write()
239
self.addCleanup(tree.unlock)
240
shelver = ExpectShelver(tree, tree.basis_tree())
241
self.addCleanup(shelver.finalize)
242
shelver.expect('Shelve? [yNfq?]', 'q')
243
self.assertRaises(errors.UserAbort, shelver.run)
244
self.assertFileEqual(LINES_ZY, 'tree/foo')
246
def test_shelve_all(self):
247
tree = self.create_shelvable_tree()
248
shelver = ExpectShelver.from_args(sys.stdout, all=True,
254
self.assertFileEqual(LINES_AJ, 'tree/foo')
256
def test_shelve_filename(self):
257
tree = self.create_shelvable_tree()
258
self.build_tree(['tree/bar'])
260
tree.lock_tree_write()
261
self.addCleanup(tree.unlock)
262
shelver = ExpectShelver(tree, tree.basis_tree(), file_list=['bar'])
263
self.addCleanup(shelver.finalize)
264
shelver.expect('Shelve adding file "bar"? [yNfq?]', 'y')
265
shelver.expect('Shelve 1 change(s)? [yNfq?]', 'y')
268
def test_shelve_help(self):
269
tree = self.create_shelvable_tree()
270
tree.lock_tree_write()
271
self.addCleanup(tree.unlock)
272
shelver = ExpectShelver(tree, tree.basis_tree())
273
self.addCleanup(shelver.finalize)
274
shelver.expect('Shelve? [yNfq?]', '?')
275
shelver.expect('Shelve? [(y)es, (N)o, (f)inish, or (q)uit]', 'f')
276
shelver.expect('Shelve 2 change(s)? [yNfq?]', 'y')
279
def test_shelve_destroy(self):
280
tree = self.create_shelvable_tree()
281
shelver = shelf_ui.Shelver.from_args(sys.stdout, all=True,
282
directory='tree', destroy=True)
283
self.addCleanup(shelver.finalize)
285
self.assertIs(None, tree.get_shelf_manager().last_shelf())
286
self.assertFileEqual(LINES_AJ, 'tree/foo')
289
def shelve_all(tree, target_revision_id):
292
target = tree.branch.repository.revision_tree(target_revision_id)
293
shelver = shelf_ui.Shelver(tree, target, auto=True,
302
def test_shelve_old_root_deleted(self):
303
tree1 = self.make_branch_and_tree('tree1')
304
tree1.commit('add root')
305
tree2 = self.make_branch_and_tree('tree2')
306
rev2 = tree2.commit('add root')
307
tree1.merge_from_branch(tree2.branch,
308
from_revision=revision.NULL_REVISION)
309
tree1.commit('Replaced root entry')
310
# This is essentially assertNotRaises(InconsistentDelta)
311
self.expectFailure('Cannot shelve replacing a root entry',
312
self.assertRaises, AssertionError,
313
self.assertRaises, errors.InconsistentDelta,
314
self.shelve_all, tree1, rev2)
316
def test_shelve_split(self):
317
outer_tree = self.make_branch_and_tree('outer')
318
outer_tree.commit('Add root')
319
inner_tree = self.make_branch_and_tree('outer/inner')
320
rev2 = inner_tree.commit('Add root')
321
outer_tree.subsume(inner_tree)
322
# This is essentially assertNotRaises(ValueError).
323
# The ValueError is 'None is not a valid file id'.
324
self.expectFailure('Cannot shelve a join back to the inner tree.',
325
self.assertRaises, AssertionError,
326
self.assertRaises, ValueError, self.shelve_all,
330
class TestApplyReporter(TestShelver):
332
def test_shelve_not_diff(self):
333
tree = self.create_shelvable_tree()
334
tree.lock_tree_write()
335
self.addCleanup(tree.unlock)
336
shelver = ExpectShelver(tree, tree.basis_tree(),
337
reporter=shelf_ui.ApplyReporter())
338
self.addCleanup(shelver.finalize)
339
shelver.expect('Apply change? [yNfq?]', 'n')
340
shelver.expect('Apply change? [yNfq?]', 'n')
341
# No final shelving prompt because no changes were selected
343
self.assertFileEqual(LINES_ZY, 'tree/foo')
345
def test_shelve_diff_no(self):
346
tree = self.create_shelvable_tree()
347
tree.lock_tree_write()
348
self.addCleanup(tree.unlock)
349
shelver = ExpectShelver(tree, tree.basis_tree(),
350
reporter=shelf_ui.ApplyReporter())
351
self.addCleanup(shelver.finalize)
352
shelver.expect('Apply change? [yNfq?]', 'y')
353
shelver.expect('Apply change? [yNfq?]', 'y')
354
shelver.expect('Apply 2 change(s)? [yNfq?]', 'n')
356
self.assertFileEqual(LINES_ZY, 'tree/foo')
358
def test_shelve_diff(self):
359
tree = self.create_shelvable_tree()
360
tree.lock_tree_write()
361
self.addCleanup(tree.unlock)
362
shelver = ExpectShelver(tree, tree.basis_tree(),
363
reporter=shelf_ui.ApplyReporter())
364
self.addCleanup(shelver.finalize)
365
shelver.expect('Apply change? [yNfq?]', 'y')
366
shelver.expect('Apply change? [yNfq?]', 'y')
367
shelver.expect('Apply 2 change(s)? [yNfq?]', 'y')
369
self.assertFileEqual(LINES_AJ, 'tree/foo')
371
def test_shelve_binary_change(self):
372
tree = self.create_shelvable_tree()
373
self.build_tree_contents([('tree/foo', '\x00')])
374
tree.lock_tree_write()
375
self.addCleanup(tree.unlock)
376
shelver = ExpectShelver(tree, tree.basis_tree(),
377
reporter=shelf_ui.ApplyReporter())
378
self.addCleanup(shelver.finalize)
379
shelver.expect('Apply binary changes? [yNfq?]', 'y')
380
shelver.expect('Apply 1 change(s)? [yNfq?]', 'y')
382
self.assertFileEqual(LINES_AJ, 'tree/foo')
384
def test_shelve_rename(self):
385
tree = self.create_shelvable_tree()
386
tree.rename_one('foo', 'bar')
387
tree.lock_tree_write()
388
self.addCleanup(tree.unlock)
389
shelver = ExpectShelver(tree, tree.basis_tree(),
390
reporter=shelf_ui.ApplyReporter())
391
self.addCleanup(shelver.finalize)
392
shelver.expect('Rename "bar" => "foo"? [yNfq?]', 'y')
393
shelver.expect('Apply change? [yNfq?]', 'y')
394
shelver.expect('Apply change? [yNfq?]', 'y')
395
shelver.expect('Apply 3 change(s)? [yNfq?]', 'y')
397
self.assertFileEqual(LINES_AJ, 'tree/foo')
399
def test_shelve_deletion(self):
400
tree = self.create_shelvable_tree()
401
os.unlink('tree/foo')
402
tree.lock_tree_write()
403
self.addCleanup(tree.unlock)
404
shelver = ExpectShelver(tree, tree.basis_tree(),
405
reporter=shelf_ui.ApplyReporter())
406
self.addCleanup(shelver.finalize)
407
shelver.expect('Add file "foo"? [yNfq?]', 'y')
408
shelver.expect('Apply 1 change(s)? [yNfq?]', 'y')
410
self.assertFileEqual(LINES_AJ, 'tree/foo')
412
def test_shelve_creation(self):
413
tree = self.make_branch_and_tree('tree')
414
tree.commit('add tree root')
415
self.build_tree(['tree/foo'])
417
tree.lock_tree_write()
418
self.addCleanup(tree.unlock)
419
shelver = ExpectShelver(tree, tree.basis_tree(),
420
reporter=shelf_ui.ApplyReporter())
421
self.addCleanup(shelver.finalize)
422
shelver.expect('Delete file "foo"? [yNfq?]', 'y')
423
shelver.expect('Apply 1 change(s)? [yNfq?]', 'y')
425
self.failIfExists('tree/foo')
427
def test_shelve_kind_change(self):
428
tree = self.create_shelvable_tree()
429
os.unlink('tree/foo')
431
tree.lock_tree_write()
432
self.addCleanup(tree.unlock)
433
shelver = ExpectShelver(tree, tree.basis_tree(),
434
reporter=shelf_ui.ApplyReporter())
435
self.addCleanup(shelver.finalize)
436
shelver.expect('Change "foo" from directory to a file? [yNfq?]', 'y')
437
shelver.expect('Apply 1 change(s)? [yNfq?]', 'y')
439
def test_shelve_modify_target(self):
440
self.requireFeature(tests.SymlinkFeature)
441
tree = self.create_shelvable_tree()
442
os.symlink('bar', 'tree/baz')
443
tree.add('baz', 'baz-id')
444
tree.commit("Add symlink")
445
os.unlink('tree/baz')
446
os.symlink('vax', 'tree/baz')
447
tree.lock_tree_write()
448
self.addCleanup(tree.unlock)
449
shelver = ExpectShelver(tree, tree.basis_tree(),
450
reporter=shelf_ui.ApplyReporter())
451
self.addCleanup(shelver.finalize)
452
shelver.expect('Change target of "baz" from "vax" to "bar"? [yNfq?]',
454
shelver.expect('Apply 1 change(s)? [yNfq?]', 'y')
456
self.assertEqual('bar', os.readlink('tree/baz'))
459
class TestUnshelver(tests.TestCaseWithTransport):
461
def create_tree_with_shelf(self):
462
tree = self.make_branch_and_tree('tree')
465
self.build_tree_contents([('tree/foo', LINES_AJ)])
466
tree.add('foo', 'foo-id')
467
tree.commit('added foo')
468
self.build_tree_contents([('tree/foo', LINES_ZY)])
469
shelver = shelf_ui.Shelver(tree, tree.basis_tree(),
470
auto_apply=True, auto=True)
479
def test_unshelve(self):
480
tree = self.create_tree_with_shelf()
482
self.addCleanup(tree.unlock)
483
manager = tree.get_shelf_manager()
484
shelf_ui.Unshelver(tree, manager, 1, True, True, True).run()
485
self.assertFileEqual(LINES_ZY, 'tree/foo')
487
def test_unshelve_args(self):
488
tree = self.create_tree_with_shelf()
489
unshelver = shelf_ui.Unshelver.from_args(directory='tree')
493
unshelver.tree.unlock()
494
self.assertFileEqual(LINES_ZY, 'tree/foo')
495
self.assertIs(None, tree.get_shelf_manager().last_shelf())
497
def test_unshelve_args_dry_run(self):
498
tree = self.create_tree_with_shelf()
499
unshelver = shelf_ui.Unshelver.from_args(directory='tree',
504
unshelver.tree.unlock()
505
self.assertFileEqual(LINES_AJ, 'tree/foo')
506
self.assertEqual(1, tree.get_shelf_manager().last_shelf())
508
def test_unshelve_args_preview(self):
509
tree = self.create_tree_with_shelf()
510
write_diff_to = StringIO()
511
unshelver = shelf_ui.Unshelver.from_args(
512
directory='tree', action='preview', write_diff_to=write_diff_to)
516
unshelver.tree.unlock()
517
# The changes were not unshelved.
518
self.assertFileEqual(LINES_AJ, 'tree/foo')
519
self.assertEqual(1, tree.get_shelf_manager().last_shelf())
521
# But the diff was written to write_diff_to.
522
diff = write_diff_to.getvalue()
523
expected = dedent("""\
538
self.assertEqualDiff(expected, diff[-len(expected):])
540
def test_unshelve_args_delete_only(self):
541
tree = self.make_branch_and_tree('tree')
542
manager = tree.get_shelf_manager()
543
shelf_file = manager.new_shelf()[1]
545
shelf_file.write('garbage')
548
unshelver = shelf_ui.Unshelver.from_args(directory='tree',
549
action='delete-only')
553
unshelver.tree.unlock()
554
self.assertIs(None, manager.last_shelf())
556
def test_unshelve_args_invalid_shelf_id(self):
557
tree = self.make_branch_and_tree('tree')
558
manager = tree.get_shelf_manager()
559
shelf_file = manager.new_shelf()[1]
561
shelf_file.write('garbage')
564
self.assertRaises(errors.InvalidShelfId,
565
shelf_ui.Unshelver.from_args, directory='tree',
566
action='delete-only', shelf_id='foo')
569
class TestUnshelveScripts(TestUnshelver,
570
script.TestCaseWithTransportAndScript):
572
def test_unshelve_messages_keep(self):
573
self.create_tree_with_shelf()
576
$ bzr unshelve --keep
577
2>Using changes with id "1".
579
2>All changes applied successfully.
582
def test_unshelve_messages_delete(self):
583
self.create_tree_with_shelf()
586
$ bzr unshelve --delete-only
587
2>Deleted changes with id "1".
590
def test_unshelve_messages_apply(self):
591
self.create_tree_with_shelf()
594
$ bzr unshelve --apply
595
2>Using changes with id "1".
597
2>All changes applied successfully.
598
2>Deleted changes with id "1".
601
def test_unshelve_messages_dry_run(self):
602
self.create_tree_with_shelf()
605
$ bzr unshelve --dry-run
606
2>Using changes with id "1".
added
removed
bzrlib/tests/test_shelf_ui.py
