1
# Copyright (C) 2008-2011, 2016 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
20
from textwrap import dedent
29
from ..sixish import (
38
class ExpectShelver(shelf_ui.Shelver):
39
"""A variant of Shelver that intercepts console activity, for testing."""
41
def __init__(self, work_tree, target_tree, diff_writer=None,
42
auto=False, auto_apply=False, file_list=None, message=None,
43
destroy=False, reporter=None):
44
shelf_ui.Shelver.__init__(self, work_tree, target_tree, diff_writer,
45
auto, auto_apply, file_list, message,
46
destroy, reporter=reporter)
48
self.diff_writer = BytesIO()
50
def expect(self, message, response):
51
self.expected.append((message, response))
53
def prompt(self, message, choices, default):
55
expected_message, response = self.expected.pop(0)
57
raise AssertionError('Unexpected prompt: %s' % message)
58
if message != expected_message:
59
raise AssertionError('Wrong prompt: %s' % message)
60
if choices != '&yes\n&No\n&finish\n&quit':
61
raise AssertionError('Wrong choices: %s' % choices)
65
LINES_AJ = b'a\nb\nc\nd\ne\nf\ng\nh\ni\nj\n'
68
LINES_ZY = b'z\nb\nc\nd\ne\nf\ng\nh\ni\ny\n'
71
LINES_AY = b'a\nb\nc\nd\ne\nf\ng\nh\ni\ny\n'
74
class ShelfTestCase(tests.TestCaseWithTransport):
76
def create_shelvable_tree(self):
77
tree = self.make_branch_and_tree('tree')
78
self.build_tree_contents([('tree/foo', LINES_AJ)])
79
tree.add('foo', b'foo-id')
80
tree.commit('added foo')
81
self.build_tree_contents([('tree/foo', LINES_ZY)])
85
class TestShelver(ShelfTestCase):
87
def test_unexpected_prompt_failure(self):
88
tree = self.create_shelvable_tree()
89
tree.lock_tree_write()
90
self.addCleanup(tree.unlock)
91
shelver = ExpectShelver(tree, tree.basis_tree())
92
self.addCleanup(shelver.finalize)
93
e = self.assertRaises(AssertionError, shelver.run)
94
self.assertEqual('Unexpected prompt: Shelve?', str(e))
96
def test_wrong_prompt_failure(self):
97
tree = self.create_shelvable_tree()
98
tree.lock_tree_write()
99
self.addCleanup(tree.unlock)
100
shelver = ExpectShelver(tree, tree.basis_tree())
101
self.addCleanup(shelver.finalize)
102
shelver.expect('foo', 0)
103
e = self.assertRaises(AssertionError, shelver.run)
104
self.assertEqual('Wrong prompt: Shelve?', str(e))
106
def test_shelve_not_diff(self):
107
tree = self.create_shelvable_tree()
108
tree.lock_tree_write()
109
self.addCleanup(tree.unlock)
110
shelver = ExpectShelver(tree, tree.basis_tree())
111
self.addCleanup(shelver.finalize)
112
shelver.expect('Shelve?', 1)
113
shelver.expect('Shelve?', 1)
114
# No final shelving prompt because no changes were selected
116
self.assertFileEqual(LINES_ZY, 'tree/foo')
118
def test_shelve_diff_no(self):
119
tree = self.create_shelvable_tree()
120
tree.lock_tree_write()
121
self.addCleanup(tree.unlock)
122
shelver = ExpectShelver(tree, tree.basis_tree())
123
self.addCleanup(shelver.finalize)
124
shelver.expect('Shelve?', 0)
125
shelver.expect('Shelve?', 0)
126
shelver.expect('Shelve 2 change(s)?', 1)
128
self.assertFileEqual(LINES_ZY, 'tree/foo')
130
def test_shelve_diff(self):
131
tree = self.create_shelvable_tree()
132
tree.lock_tree_write()
133
self.addCleanup(tree.unlock)
134
shelver = ExpectShelver(tree, tree.basis_tree())
135
self.addCleanup(shelver.finalize)
136
shelver.expect('Shelve?', 0)
137
shelver.expect('Shelve?', 0)
138
shelver.expect('Shelve 2 change(s)?', 0)
140
self.assertFileEqual(LINES_AJ, 'tree/foo')
142
def test_shelve_one_diff(self):
143
tree = self.create_shelvable_tree()
144
tree.lock_tree_write()
145
self.addCleanup(tree.unlock)
146
shelver = ExpectShelver(tree, tree.basis_tree())
147
self.addCleanup(shelver.finalize)
148
shelver.expect('Shelve?', 0)
149
shelver.expect('Shelve?', 1)
150
shelver.expect('Shelve 1 change(s)?', 0)
152
self.assertFileEqual(LINES_AY, 'tree/foo')
154
def test_shelve_binary_change(self):
155
tree = self.create_shelvable_tree()
156
self.build_tree_contents([('tree/foo', b'\x00')])
157
tree.lock_tree_write()
158
self.addCleanup(tree.unlock)
159
shelver = ExpectShelver(tree, tree.basis_tree())
160
self.addCleanup(shelver.finalize)
161
shelver.expect('Shelve binary changes?', 0)
162
shelver.expect('Shelve 1 change(s)?', 0)
164
self.assertFileEqual(LINES_AJ, 'tree/foo')
166
def test_shelve_rename(self):
167
tree = self.create_shelvable_tree()
168
tree.rename_one('foo', 'bar')
169
tree.lock_tree_write()
170
self.addCleanup(tree.unlock)
171
shelver = ExpectShelver(tree, tree.basis_tree())
172
self.addCleanup(shelver.finalize)
173
shelver.expect('Shelve renaming "foo" => "bar"?', 0)
174
shelver.expect('Shelve?', 0)
175
shelver.expect('Shelve?', 0)
176
shelver.expect('Shelve 3 change(s)?', 0)
178
self.assertFileEqual(LINES_AJ, 'tree/foo')
180
def test_shelve_deletion(self):
181
tree = self.create_shelvable_tree()
182
os.unlink('tree/foo')
183
tree.lock_tree_write()
184
self.addCleanup(tree.unlock)
185
shelver = ExpectShelver(tree, tree.basis_tree())
186
self.addCleanup(shelver.finalize)
187
shelver.expect('Shelve removing file "foo"?', 0)
188
shelver.expect('Shelve 1 change(s)?', 0)
190
self.assertFileEqual(LINES_AJ, 'tree/foo')
192
def test_shelve_creation(self):
193
tree = self.make_branch_and_tree('tree')
194
tree.commit('add tree root')
195
self.build_tree(['tree/foo'])
197
tree.lock_tree_write()
198
self.addCleanup(tree.unlock)
199
shelver = ExpectShelver(tree, tree.basis_tree())
200
self.addCleanup(shelver.finalize)
201
shelver.expect('Shelve adding file "foo"?', 0)
202
shelver.expect('Shelve 1 change(s)?', 0)
204
self.assertPathDoesNotExist('tree/foo')
206
def test_shelve_kind_change(self):
207
tree = self.create_shelvable_tree()
208
os.unlink('tree/foo')
210
tree.lock_tree_write()
211
self.addCleanup(tree.unlock)
212
shelver = ExpectShelver(tree, tree.basis_tree())
213
self.addCleanup(shelver.finalize)
214
shelver.expect('Shelve changing "foo" from file to directory?',
216
shelver.expect('Shelve 1 change(s)?', 0)
218
def test_shelve_modify_target(self):
219
self.requireFeature(features.SymlinkFeature)
220
tree = self.create_shelvable_tree()
221
os.symlink('bar', 'tree/baz')
222
tree.add('baz', b'baz-id')
223
tree.commit("Add symlink")
224
os.unlink('tree/baz')
225
os.symlink('vax', 'tree/baz')
226
tree.lock_tree_write()
227
self.addCleanup(tree.unlock)
228
shelver = ExpectShelver(tree, tree.basis_tree())
229
self.addCleanup(shelver.finalize)
230
shelver.expect('Shelve changing target of "baz" from "bar" to '
232
shelver.expect('Shelve 1 change(s)?', 0)
234
self.assertEqual('bar', os.readlink('tree/baz'))
236
def test_shelve_finish(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?', 2)
243
shelver.expect('Shelve 2 change(s)?', 0)
245
self.assertFileEqual(LINES_AJ, 'tree/foo')
247
def test_shelve_quit(self):
248
tree = self.create_shelvable_tree()
249
tree.lock_tree_write()
250
self.addCleanup(tree.unlock)
251
shelver = ExpectShelver(tree, tree.basis_tree())
252
self.addCleanup(shelver.finalize)
253
shelver.expect('Shelve?', 3)
254
self.assertRaises(errors.UserAbort, shelver.run)
255
self.assertFileEqual(LINES_ZY, 'tree/foo')
257
def test_shelve_all(self):
258
self.create_shelvable_tree()
259
shelver = ExpectShelver.from_args(sys.stdout, all=True,
265
self.assertFileEqual(LINES_AJ, 'tree/foo')
267
def test_shelve_filename(self):
268
tree = self.create_shelvable_tree()
269
self.build_tree(['tree/bar'])
271
tree.lock_tree_write()
272
self.addCleanup(tree.unlock)
273
shelver = ExpectShelver(tree, tree.basis_tree(), file_list=['bar'])
274
self.addCleanup(shelver.finalize)
275
shelver.expect('Shelve adding file "bar"?', 0)
276
shelver.expect('Shelve 1 change(s)?', 0)
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_preserved(self):
303
tree1 = self.make_branch_and_tree('tree1')
304
tree1.commit('add root')
305
tree1_root_id = tree1.path2id('')
306
tree2 = self.make_branch_and_tree('tree2')
307
rev2 = tree2.commit('add root')
308
self.assertNotEqual(tree1_root_id, tree2.path2id(''))
309
tree1.merge_from_branch(tree2.branch,
310
from_revision=revision.NULL_REVISION)
311
tree1.commit('merging in tree2')
312
self.assertEqual(tree1_root_id, tree1.path2id(''))
313
# This is essentially assertNotRaises(InconsistentDelta)
314
# With testtools 0.9.9, 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?', 1)
348
shelver.expect('Apply change?', 1)
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?', 0)
361
shelver.expect('Apply change?', 0)
362
shelver.expect('Apply 2 change(s)?', 1)
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?', 0)
374
shelver.expect('Apply change?', 0)
375
shelver.expect('Apply 2 change(s)?', 0)
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', b'\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?', 0)
388
shelver.expect('Apply 1 change(s)?', 0)
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"?', 0)
401
shelver.expect('Apply change?', 0)
402
shelver.expect('Apply change?', 0)
403
shelver.expect('Apply 3 change(s)?', 0)
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"?', 0)
416
shelver.expect('Apply 1 change(s)?', 0)
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"?', 0)
431
shelver.expect('Apply 1 change(s)?', 0)
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?', 0)
445
shelver.expect('Apply 1 change(s)?', 0)
447
def test_shelve_modify_target(self):
448
self.requireFeature(features.SymlinkFeature)
449
tree = self.create_shelvable_tree()
450
os.symlink('bar', 'tree/baz')
451
tree.add('baz', b'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"?',
462
shelver.expect('Apply 1 change(s)?', 0)
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', b'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 = BytesIO()
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.encode('utf-8'), 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(b'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(b'garbage')
572
self.assertRaises(shelf.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
$ brz 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
$ brz unshelve --delete-only
595
2>Deleted changes with id "1".
598
def test_unshelve_messages_apply(self):
599
self.create_tree_with_shelf()
602
$ brz 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
$ brz unshelve --dry-run
614
2>Using changes with id "1".