2
from bzrlib.diff import _patch_header_date
5
from bzrlib.plugins.bzrtools.hunk_selector import (
9
from bzrlib.plugins.bzrtools.errors import NoColor
10
from bzrlib.plugins.bzrtools.command_classes import cmd_shelf
13
class ShelfTests(bzrlib.tests.TestCaseWithTransport):
14
ORIGINAL = '\n\nhello test world\n\n'
15
MODIFIED = '\n\ngoodbye test world\n\n'
16
DIFF_HEADER = "=== modified file '%(filename)s'\n"
17
DIFF_1 = """--- %(filename)s\t%(old_date)s
18
+++ %(filename)s\t%(new_date)s
26
DIFF_2 = """--- test_file\t%(old_date)s
27
+++ test_file\t%(new_date)s
35
def _check_diff(self, diff=DIFF_1, filename='test_file'):
36
old_tree = self.tree.basis_tree()
40
old_date = _patch_header_date(old_tree,
41
old_tree.inventory.path2id(filename),
43
new_date = _patch_header_date(self.tree,
44
self.tree.inventory.path2id(filename), filename)
48
keys = { 'filename' : filename , 'old_date': old_date,
50
hdr = self.DIFF_HEADER % keys
52
self.assertEqual(self.run_bzr('diff', retcode=1)[0], hdr + diff + '\n')
54
def _check_shelf(self, idx, diff=DIFF_1, filename='test_file',
56
old_tree = self.tree.basis_tree()
59
old_date = _patch_header_date(old_tree,
60
old_tree.inventory.path2id(filename),
64
diff = diff % { 'filename' : filename, 'old_date': old_date,
66
shelf = open(os.path.join(self.tree.basedir,
67
'.shelf/shelves/default/' + idx)).read()
68
shelf = shelf[shelf.index('\n') + 1:] # skip the message
69
self.assertEqual(shelf, diff)
74
def test_shelf_multi(self):
77
def __test_loop(self, count):
78
self.tree = self.make_branch_and_tree('.')
79
self.__create_and_add_test_file()
80
for counter in range(count):
81
# Modify the test file
82
# write in binary mode because on win32 line-endings should be
84
f = file('test_file', 'wb')
85
f.write(self.MODIFIED)
90
self.tree.lock_write()
92
new_date = _patch_header_date(self.tree,
93
self.tree.inventory.path2id('test_file'), 'test_file')
98
self.run_bzr('shelve --all', retcode=0)
100
# Make sure there is no diff anymore
101
self.assertEqual(self.run_bzr('diff', retcode=0)[0], '')
103
# Make sure the file is actually back the way it was
104
self.assertEqual(file('test_file').read(), self.ORIGINAL)
106
self._check_shelf('00', new_date=new_date)
109
self.run_bzr('unshelve --all', retcode=0)
113
# Check the shelved patch was backed up
114
self._check_shelf('00~', new_date=new_date)
116
# Make sure the file is back the way it should be
117
self.assertEqual(file('test_file').read(), self.MODIFIED)
119
def test_shelf_nothing_to_shelve(self):
121
self.tree = self.make_branch_and_tree('.')
122
self.__create_and_add_test_file()
125
self.run_bzr('shelve --all', retcode=3)
127
if os.path.exists(os.path.join(self.tree.branch.base,
128
'.shelf/shelves/default/00')):
129
self.fail("Shelf exists, but it shouldn't")
131
def __create_and_add_test_file(self, filename='test_file'):
132
# write in binary mode because on win32 line-endings should be LF
133
f = open(filename, 'wb')
134
f.write(self.ORIGINAL)
136
self.tree.add(self.tree.relpath(os.path.join(os.getcwd(), filename)))
137
self.tree.commit(message='add %s' % filename)
139
def test_shelf_with_revision(self):
140
self.tree = self.make_branch_and_tree('.')
142
self.__create_and_add_test_file()
144
# Modify the test file and commit it
145
self.build_tree_contents([('test_file', self.MODIFIED)])
146
self.tree.commit(message='update test_file')
149
self.run_bzr('shelve --all -r 1', retcode=0)
151
self._check_diff(self.DIFF_2)
153
# Make sure the file is the way it should be
154
self.assertEqual(file('test_file').read(), self.ORIGINAL)
157
self.run_bzr('unshelve --all', retcode=0)
159
# Make sure the file is back the way it should be
160
self.assertEqual(file('test_file').read(), self.MODIFIED)
162
def test_shelf_with_two_revisions(self):
163
self.tree = self.make_branch_and_tree('.')
165
stdout, stderr = self.run_bzr('shelve --all -r 1..2', retcode=None)
167
self.assertEqual(stderr.split('\n')[0],
168
'bzr: ERROR: shelve only accepts a single revision parameter.')
170
def test_shelf_show_basic(self):
171
self.tree = self.make_branch_and_tree('.')
172
self.__create_and_add_test_file()
173
self.__test_show(self.tree, '00')
175
def __test_show(self, tree, patch):
176
# Modify the test file
177
self.build_tree_contents([('test_file', 'patch %s\n' % patch)])
180
self.run_bzr('shelve --all', retcode=0)
182
# Make sure there is no diff anymore
183
self.assertEqual(self.run_bzr('diff', retcode=0)[0], '')
185
# Check the shelf is right
186
shelf = open(os.path.join(self.tree.basedir,
187
'.shelf/shelves/default', patch)).read()
188
self.assertTrue('patch %s' % patch in shelf)
190
# Check the shown output is right
191
shown = self.run_bzr('shelf show %s' % patch, retcode=0)[0]
192
self.assertEqual(shown, shelf)
194
def test_shelf_show_multi(self):
195
self.tree = self.make_branch_and_tree('.')
196
self.__create_and_add_test_file()
197
self.__test_show(self.tree, '00')
198
self.__test_show(self.tree, '01')
199
self.__test_show(self.tree, '02')
201
# Now check we can show a previously shelved patch
202
shelf = open(os.path.join(self.tree.basedir,
203
'.shelf/shelves/default/00')).read()
204
self.assertTrue('patch 00' in shelf)
206
# Check the shown output is right
207
shown = self.run_bzr('shelf show 00', retcode=0)[0]
208
self.assertEqual(shown, shelf)
210
def test_shelf_show_unspecified(self):
211
self.tree = self.make_branch_and_tree('.')
212
self.__create_and_add_test_file()
213
self.__test_show(self.tree, '00')
214
self.__test_show(self.tree, '01')
215
self.__test_show(self.tree, '02')
217
# Check that not specifying at patch gets us the most recent
218
shelf = open(os.path.join(self.tree.basedir,
219
'.shelf/shelves/default/02')).read()
220
self.assertTrue('patch 02' in shelf)
222
# Check the shown output is right
223
shown = self.run_bzr('shelf show', retcode=0)[0]
224
self.assertEqual(shown, shelf)
226
def test_shelf_show_with_no_patch(self):
227
self.tree = self.make_branch_and_tree('.')
228
stderr = self.run_bzr('shelf show 00', retcode=None)[1]
229
self.assertTrue("Patch '00' doesn't exist on shelf default!" in stderr)
231
def test_shelf_unshelve_failure(self):
232
self.tree = self.make_branch_and_tree('.')
234
self.__create_and_add_test_file()
236
# Modify the test file
237
file('test_file', 'w').write(self.MODIFIED)
240
self.run_bzr('shelve --all', retcode=0)
242
# Write an unapplyable patch into the shelf
243
shelf = open(os.path.join(self.tree.basedir,
244
'.shelf/shelves/default/00'), 'w')
245
shelf.write(self.DIFF_2)
248
# Unshelve, should fail
249
self.run_bzr('unshelve --all', retcode=3)
251
# Make sure the patch is still there, eventhough it's broken
252
shelf = open(os.path.join(self.tree.basedir,
253
'.shelf/shelves/default/00')).read()
254
self.assertEqual(shelf, self.DIFF_2)
256
# Working tree should be unchanged
257
diff = self.run_bzr('diff', retcode=0)[0]
258
self.assertEqual(diff, '')
260
def test_shelf_unshelve_failure_two_hunks(self):
261
self.tree = self.make_branch_and_tree('.')
263
self.__create_and_add_test_file()
264
self.__create_and_add_test_file(filename='test_file2')
266
# Modify the test files
267
file('test_file', 'w').write(self.MODIFIED)
268
file('test_file2', 'w').write(self.MODIFIED)
271
self.run_bzr('shelve --all', retcode=0)
273
# Put the changes to test_file back, the shelved patch won't apply now
274
file('test_file', 'w').write(self.MODIFIED)
275
self.tree.commit(message='screw up test_file')
277
# Unshelve, should fail
278
self.run_bzr('unshelve --all', retcode=3)
280
# Working tree should be unchanged
281
diff = self.run_bzr('diff', retcode=0)[0]
282
self.assertEqual(diff, '')
284
# Force should succeed and modify test_file2, but leave shelf
285
self.run_bzr('unshelve --force --all', retcode=0)
286
self.assertEqual(open('test_file2').read(), self.MODIFIED)
287
self.assertTrue(os.path.exists('.shelf/shelves/default/00'))
289
def test_shelf_after_unshelve(self):
290
self.tree = self.make_branch_and_tree('.')
292
self.__create_and_add_test_file()
293
self.__create_and_add_test_file(filename='test_file2')
295
# Modify the test files
296
file('test_file', 'w').write(self.MODIFIED)
297
file('test_file2', 'w').write(self.MODIFIED)
300
self.run_bzr('shelve --all test_file', retcode=0)
301
self.run_bzr('shelve --all test_file2', retcode=0)
304
self.run_bzr('unshelve --all', retcode=0)
306
# We should now have 00 and 01~
307
self.assertTrue(os.path.exists('.shelf/shelves/default/00'))
308
self.assertTrue(os.path.exists('.shelf/shelves/default/01~'))
311
lines = self.run_bzr('shelf ls', retcode=0)[0].split('\n')
313
self.assertFalse(line.startswith(' 01'))
315
# Unshelve, if unshelve is confused by the backup it will fail
316
self.run_bzr('unshelve --all', retcode=0)
318
def test_shelf_delete(self):
319
self.tree = self.make_branch_and_tree('.')
320
self.tree.lock_write()
322
self.__create_and_add_test_file()
323
self.__create_and_add_test_file(filename='test_file2')
325
# Modify the test files
326
# write in binary mode because on win32 line-endings should be LF
327
f = file('test_file', 'wb')
328
f.write(self.MODIFIED)
330
f = file('test_file2', 'wb')
331
f.write(self.MODIFIED)
333
new_date = _patch_header_date(self.tree,
334
self.tree.inventory.path2id('test_file'), 'test_file')
339
self.run_bzr('shelve --all test_file', retcode=0)
340
self.run_bzr('shelve --all test_file2', retcode=0)
342
self._check_shelf('00', new_date=new_date)
345
self.run_bzr('shelf delete 00', retcode=0)
347
# We should now have 01 but not 00, but we should have 00~
348
self.assertFalse(os.path.exists('.shelf/shelves/default/00'))
349
self.assertTrue(os.path.exists('.shelf/shelves/default/00~'))
350
self.assertTrue(os.path.exists('.shelf/shelves/default/01'))
352
# Check the backup is right
353
self._check_shelf('00~', new_date=new_date)
356
lines = self.run_bzr('shelf ls', retcode=0)[0].split('\n')
358
self.assertFalse(line.startswith(' 00'))
360
# Unshelve should unshelve 01
361
self.run_bzr('unshelve --all', retcode=0)
362
self.assertEqual(file('test_file2').read(), self.MODIFIED)
364
def test_shelf_gaps(self):
365
self.tree = self.make_branch_and_tree('.')
366
self.__create_and_add_test_file()
367
file('test_file', 'w').write(self.MODIFIED)
368
self.run_bzr('shelve --all test_file', retcode=0)
369
file('test_file', 'w').write(self.MODIFIED)
370
self.run_bzr('shelve --all test_file', retcode=0)
372
# Now delete 00, leaving 01, next shelve should go into 02
373
self.run_bzr('shelf delete 0', retcode=0)
374
self.assertFalse(os.path.exists('.shelf/shelves/default/00'))
375
self.assertFalse(os.path.exists('.shelf/shelves/default/02'))
376
file('test_file', 'w').write(self.MODIFIED)
377
self.run_bzr('shelve --all test_file', retcode=0)
378
self.assertFalse(os.path.exists('.shelf/shelves/default/00'))
379
self.assertTrue(os.path.exists('.shelf/shelves/default/02'))
381
def test_shelf_upgrade(self):
382
self.tree = self.make_branch_and_tree('.')
384
self.__create_and_add_test_file()
386
# Modify then shelve, so we're not upgrading to 00, just for kicks
387
file('test_file', 'w').write(self.MODIFIED)
388
self.run_bzr('shelve --all test_file', retcode=0)
390
open('.bzr-shelf', 'w').write('First old shelf')
391
open('.bzr-shelf-1', 'w').write('Second old shelf')
392
open('.bzr-shelf-3', 'w').write('Fourth old shelf')
394
# shelve and unshelve should bitch and do nothing
395
file('test_file', 'w').write('blah blah blah')
396
self.run_bzr('shelve --all', retcode=3)
397
self.assertFalse(os.path.exists('.shelf/shelves/default/01'))
398
self.assertEqual(file('test_file').read(), 'blah blah blah')
399
self.run_bzr('unshelve --all', retcode=3)
400
self.assertTrue(os.path.exists('.shelf/shelves/default/00'))
402
# Upgrade, make sure it worked
403
self.run_bzr('shelf upgrade', retcode=0)
404
self.assertEqual(open('.shelf/shelves/default/01').read(),
406
self.assertEqual(open('.shelf/shelves/default/02').read(),
408
self.assertEqual(open('.shelf/shelves/default/03').read(),
411
# Check the old shelves got backed up right
412
self.assertTrue(os.path.exists('.bzr-shelf~'))
413
self.assertTrue(os.path.exists('.bzr-shelf-1~'))
414
self.assertTrue(os.path.exists('.bzr-shelf-3~'))
415
self.assertFalse(os.path.exists('.bzr-shelf'))
416
self.assertFalse(os.path.exists('.bzr-shelf-1'))
417
self.assertFalse(os.path.exists('.bzr-shelf-3'))
419
# Shelve should work now
420
self.run_bzr('shelve --all', retcode=0)
422
def test_shelf_p1_patch(self):
423
self.tree = self.make_branch_and_tree('.')
425
self.__create_and_add_test_file()
427
# Run a benign shelf command to setup .shelf for us
428
self.run_bzr('shelf ls', retcode=0)
430
old_tree = self.tree.basis_tree()
432
self.tree.lock_read()
434
old_date = _patch_header_date(old_tree,
435
old_tree.inventory.path2id('test_file'),
437
new_date = _patch_header_date(self.tree,
438
self.tree.inventory.path2id('test_file'), 'test_file')
442
# Fake a -p0 shelved patch
443
diff = self.DIFF_1 % { 'filename' : 'test_file', 'old_date': old_date,
444
'new_date' : new_date}
445
diff = diff.replace('--- ', '--- a/')
446
diff = diff.replace('+++ ', '+++ b/')
447
open('.shelf/shelves/default/00', 'w').write(diff)
450
self.run_bzr('unshelve --all', retcode=0)
454
def test_shelf_shelve_in_subdir(self):
455
self.tree = self.make_branch_and_tree('.')
459
self.tree.add(subdir)
462
self.__create_and_add_test_file()
464
# Modify the test file
465
# write in binary mode because on win32 line-endings should be LF
466
f = file('test_file', 'wb')
467
f.write(self.MODIFIED)
471
self.run_bzr('shelve --all', retcode=0)
473
# Working tree should be unchanged
474
diff = self.run_bzr('diff', retcode=0)[0]
475
self.assertEqual(diff, '')
477
# Unshelve, should succeed
478
self.run_bzr('unshelve --all', retcode=0)
480
self._check_diff(filename='subdir/test_file')
482
# Make sure relative filenames work ok
483
self.run_bzr('shelve test_file --all', retcode=0)
485
def test_shelf_shelf_bogus_subcommand(self):
486
self.tree = self.make_branch_and_tree('.')
487
self.run_bzr('shelf foo', retcode=3) # <- retcode == 3
489
def test_shelf_OOO_unshelve(self):
490
self.tree = self.make_branch_and_tree('.')
492
for i in range(1, 5):
493
self.__create_and_add_test_file(filename='test_file%d' % i)
495
# Modify the test files
496
for i in range(1, 5):
497
file('test_file%d' % i, 'w').write(self.MODIFIED)
500
for i in range(1, 5):
501
self.run_bzr(['shelve', '--all', 'test_file%d' % i], retcode=0)
503
# Check shelving worked
504
for i in range(1, 5):
505
self.assertEqual(file('test_file%d' % i).read(), self.ORIGINAL)
507
# We should now have 00-03
508
for i in range(0, 4):
509
self.assertTrue(os.path.exists('.shelf/shelves/default/0%d' % i))
512
self.run_bzr('unshelve --all 00', retcode=0)
513
self.assertEqual(file('test_file1').read(), self.MODIFIED)
516
lines = self.run_bzr('shelf ls', retcode=0)[0].split('\n')
518
self.assertFalse(line.startswith(' 00'))
520
# Check we can reshelve once we've unshelved out of order, should be 04
521
self.assertFalse(os.path.exists('.shelf/shelves/default/04'))
522
self.run_bzr('shelve --all')
523
self.assertTrue(os.path.exists('.shelf/shelves/default/04'))
526
text = self.run_bzr('shelf ls', retcode=0)[0]
527
for line in text.split('\n'):
528
self.assertFalse(line.startswith(' 00'))
530
# We now have 01,02,03,04
532
self.run_bzr('unshelve --all 02', retcode=0)
533
self.assertEqual(file('test_file3').read(), self.MODIFIED)
535
# Unshelve the default, this is the reshelved 00, hence modifies file 1
536
self.run_bzr('unshelve --all', retcode=0)
537
self.assertEqual(file('test_file1').read(), self.MODIFIED)
539
def test_shelf_switch_basic(self):
540
self.tree = self.make_branch_and_tree('.')
541
self.__create_and_add_test_file()
543
# This should go to "default"
544
file('test_file', 'w').write(self.MODIFIED)
545
self.run_bzr('shelve --all test_file', retcode=0)
548
self.run_bzr('shelf switch other', retcode=0)
549
file('test_file', 'w').write(self.MODIFIED)
550
self.run_bzr('shelve --all test_file', retcode=0)
553
self.assertTrue(os.path.exists('.shelf/shelves/default/00'))
554
self.assertFalse(os.path.exists('.shelf/shelves/default/01'))
555
self.assertTrue(os.path.exists('.shelf/shelves/other/00'))
558
self.run_bzr('shelf switch default', retcode=0)
559
file('test_file', 'w').write(self.MODIFIED)
560
self.run_bzr('shelve --all test_file', retcode=0)
563
self.assertTrue(os.path.exists('.shelf/shelves/default/01'))
564
self.assertFalse(os.path.exists('.shelf/shelves/other/01'))
566
def test_shelf_binary(self):
567
self.tree = self.make_branch_and_tree('.')
568
self.build_tree_contents([('file', '\x00')])
569
self.tree.add('file')
570
self.run_bzr_error(['Changes involve binary files.'], 'shelve --all')
572
def test_shelf_bad_patch_arg(self):
573
self.tree = self.make_branch_and_tree('.')
575
# Check the bad arg handling
576
stdout, error = self.run_bzr('unshelve 01', retcode=3)
577
self.assertTrue("Patch '01' doesn't exist on shelf" in error)
579
stdout, error = self.run_bzr('unshelve foo', retcode=3)
580
self.assertTrue("Invalid patch name 'foo'" in error)
582
# Hex and is cracky, so it shouldn't work
583
stdout, error = self.run_bzr(['unshelve', '0x00'], retcode=3)
584
self.assertTrue("Invalid patch name '0x00'" in error)
586
def test_color_hunk_selector(self):
587
"""Make sure NoColor is raised iff terminal.has_ansi_colors is False"""
588
hs = ShelveHunkSelector([])
589
hs = UnshelveHunkSelector([])
591
from bzrlib.plugins.bzrtools import terminal
593
from bzrtools import terminal
594
old_has_ansi_colors = terminal.has_ansi_colors
595
terminal.has_ansi_colors = lambda: False
597
self.assertRaises(NoColor, ShelveHunkSelector, [], True)
598
self.assertRaises(NoColor, UnshelveHunkSelector, [], True)
599
terminal.has_ansi_colors = lambda: True
600
hs = ShelveHunkSelector([], color=True)
601
hs = UnshelveHunkSelector([], color=True)
603
terminal.has_ansi_colors = old_has_ansi_colors
605
def test_no_color(self):
606
"""Ensure --no-color switch can be passed"""
607
self.tree = self.make_branch_and_tree('.')
611
self.tree.add(subdir)
614
self.__create_and_add_test_file()
616
# Modify the test file
617
# write in binary mode because on win32 line-endings should be LF
618
f = file('test_file', 'wb')
619
f.write(self.MODIFIED)
621
stdout, error = self.run_bzr('shelve --all --no-color')
622
stdout, error = self.run_bzr('unshelve --all --no-color')
624
def test_shelf_help(self):
625
self.assertContainsRe(cmd_shelf().help(),
626
'list\n.*List the patches on the current shelf')
628
def test_show_empty_shelf(self):
629
self.tree = self.make_branch_and_tree('.')
630
self.run_bzr_error(('No patches on shelf.',), 'shelf show')