1
# Copyright (C) 2005, 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Tests for the commit CLI of bzr."""
29
from bzrlib.bzrdir import BzrDir
30
from bzrlib.tests import (
34
from bzrlib.tests.blackbox import ExternalBase
37
class TestCommit(ExternalBase):
39
def test_05_empty_commit(self):
40
"""Commit of tree with no versioned files should fail"""
41
# If forced, it should succeed, but this is not tested here.
42
self.make_branch_and_tree('.')
43
self.build_tree(['hello.txt'])
44
out,err = self.run_bzr('commit -m empty', retcode=3)
45
self.assertEqual('', out)
46
self.assertContainsRe(err, 'bzr: ERROR: no changes to commit\.'
47
' use --unchanged to commit anyhow\n')
49
def test_commit_success(self):
50
"""Successful commit should not leave behind a bzr-commit-* file"""
51
self.make_branch_and_tree('.')
52
self.run_bzr('commit --unchanged -m message')
53
self.assertEqual('', self.run_bzr('unknowns')[0])
55
# same for unicode messages
56
self.run_bzr(["commit", "--unchanged", "-m", u'foo\xb5'])
57
self.assertEqual('', self.run_bzr('unknowns')[0])
59
def test_commit_with_path(self):
60
"""Commit tree with path of root specified"""
61
a_tree = self.make_branch_and_tree('a')
62
self.build_tree(['a/a_file'])
64
self.run_bzr(['commit', '-m', 'first commit', 'a'])
66
b_tree = a_tree.bzrdir.sprout('b').open_workingtree()
67
self.build_tree_contents([('b/a_file', 'changes in b')])
68
self.run_bzr(['commit', '-m', 'first commit in b', 'b'])
70
self.build_tree_contents([('a/a_file', 'new contents')])
71
self.run_bzr(['commit', '-m', 'change in a', 'a'])
73
b_tree.merge_from_branch(a_tree.branch)
74
self.assertEqual(len(b_tree.conflicts()), 1)
75
self.run_bzr('resolved b/a_file')
76
self.run_bzr(['commit', '-m', 'merge into b', 'b'])
79
def test_10_verbose_commit(self):
80
"""Add one file and examine verbose commit output"""
81
tree = self.make_branch_and_tree('.')
82
self.build_tree(['hello.txt'])
84
out,err = self.run_bzr('commit -m added')
85
self.assertEqual('', out)
86
self.assertContainsRe(err, '^Committing to: .*\n'
88
'Committed revision 1.\n$',)
90
def prepare_simple_history(self):
91
"""Prepare and return a working tree with one commit of one file"""
92
# Commit with modified file should say so
93
wt = BzrDir.create_standalone_workingtree('.')
94
self.build_tree(['hello.txt', 'extra.txt'])
96
wt.commit(message='added')
99
def test_verbose_commit_modified(self):
100
# Verbose commit of modified file should say so
101
wt = self.prepare_simple_history()
102
self.build_tree_contents([('hello.txt', 'new contents')])
103
out, err = self.run_bzr('commit -m modified')
104
self.assertEqual('', out)
105
self.assertContainsRe(err, '^Committing to: .*\n'
106
'modified hello\.txt\n'
107
'Committed revision 2\.\n$')
109
def test_verbose_commit_renamed(self):
110
# Verbose commit of renamed file should say so
111
wt = self.prepare_simple_history()
112
wt.rename_one('hello.txt', 'gutentag.txt')
113
out, err = self.run_bzr('commit -m renamed')
114
self.assertEqual('', out)
115
self.assertContainsRe(err, '^Committing to: .*\n'
116
'renamed hello\.txt => gutentag\.txt\n'
117
'Committed revision 2\.$\n')
119
def test_verbose_commit_moved(self):
120
# Verbose commit of file moved to new directory should say so
121
wt = self.prepare_simple_history()
124
wt.rename_one('hello.txt', 'subdir/hello.txt')
125
out, err = self.run_bzr('commit -m renamed')
126
self.assertEqual('', out)
127
self.assertContainsRe(err, '^Committing to: .*\n'
129
'renamed hello\.txt => subdir/hello\.txt\n'
130
'Committed revision 2\.\n$')
132
def test_verbose_commit_with_unknown(self):
133
"""Unknown files should not be listed by default in verbose output"""
134
# Is that really the best policy?
135
wt = BzrDir.create_standalone_workingtree('.')
136
self.build_tree(['hello.txt', 'extra.txt'])
137
wt.add(['hello.txt'])
138
out,err = self.run_bzr('commit -m added')
139
self.assertEqual('', out)
140
self.assertContainsRe(err, '^Committing to: .*\n'
142
'Committed revision 1\.\n$')
144
def test_verbose_commit_with_unchanged(self):
145
"""Unchanged files should not be listed by default in verbose output"""
146
tree = self.make_branch_and_tree('.')
147
self.build_tree(['hello.txt', 'unchanged.txt'])
148
tree.add('unchanged.txt')
149
self.run_bzr('commit -m unchanged unchanged.txt')
150
tree.add("hello.txt")
151
out,err = self.run_bzr('commit -m added')
152
self.assertEqual('', out)
153
self.assertContainsRe(err, '^Committing to: .*\n'
155
'Committed revision 2\.$\n')
157
def test_verbose_commit_includes_master_location(self):
158
"""Location of master is displayed when committing to bound branch"""
159
a_tree = self.make_branch_and_tree('a')
160
self.build_tree(['a/b'])
162
a_tree.commit(message='Initial message')
164
b_tree = a_tree.branch.create_checkout('b')
165
expected = "%s/" % (osutils.abspath('a'), )
166
out, err = self.run_bzr('commit -m blah --unchanged', working_dir='b')
167
self.assertEqual(err, 'Committing to: %s\n'
168
'Committed revision 2.\n' % expected)
170
def test_commit_merge_reports_all_modified_files(self):
171
# the commit command should show all the files that are shown by
172
# bzr diff or bzr status when committing, even when they were not
173
# changed by the user but rather through doing a merge.
174
this_tree = self.make_branch_and_tree('this')
175
# we need a bunch of files and dirs, to perform one action on each.
178
'this/dirtoreparent/',
181
'this/filetoreparent',
198
this_tree.commit('create_files')
199
other_dir = this_tree.bzrdir.sprout('other')
200
other_tree = other_dir.open_workingtree()
201
other_tree.lock_write()
202
# perform the needed actions on the files and dirs.
204
other_tree.rename_one('dirtorename', 'renameddir')
205
other_tree.rename_one('dirtoreparent', 'renameddir/reparenteddir')
206
other_tree.rename_one('filetorename', 'renamedfile')
207
other_tree.rename_one('filetoreparent',
208
'renameddir/reparentedfile')
209
other_tree.remove(['dirtoremove', 'filetoremove'])
210
self.build_tree_contents([
212
('other/filetomodify', 'new content'),
213
('other/newfile', 'new file content')])
214
other_tree.add('newfile')
215
other_tree.add('newdir/')
216
other_tree.commit('modify all sample files and dirs.')
219
this_tree.merge_from_branch(other_tree.branch)
221
out,err = self.run_bzr('commit -m added')
222
self.assertEqual('', out)
223
expected = '%s/' % (osutils.getcwd(), )
224
self.assertEqualDiff(
225
'Committing to: %s\n'
226
'modified filetomodify\n'
229
'renamed dirtorename => renameddir\n'
230
'renamed filetorename => renamedfile\n'
231
'renamed dirtoreparent => renameddir/reparenteddir\n'
232
'renamed filetoreparent => renameddir/reparentedfile\n'
233
'deleted dirtoremove\n'
234
'deleted filetoremove\n'
235
'Committed revision 2.\n' % (expected, ),
238
def test_empty_commit_message(self):
239
tree = self.make_branch_and_tree('.')
240
self.build_tree_contents([('foo.c', 'int main() {}')])
242
self.run_bzr('commit -m ""', retcode=3)
244
def test_unsupported_encoding_commit_message(self):
245
tree = self.make_branch_and_tree('.')
246
self.build_tree_contents([('foo.c', 'int main() {}')])
248
# LANG env variable has no effect on Windows
249
# but some characters anyway cannot be represented
250
# in default user encoding
251
char = probe_bad_non_ascii(osutils.get_user_encoding())
253
raise TestSkipped('Cannot find suitable non-ascii character'
254
'for user_encoding (%s)' % osutils.get_user_encoding())
255
out,err = self.run_bzr_subprocess('commit -m "%s"' % char,
257
env_changes={'LANG': 'C'})
258
self.assertContainsRe(err, r'bzrlib.errors.BzrError: Parameter.*is '
259
'unsupported by the current encoding.')
261
def test_other_branch_commit(self):
262
# this branch is to ensure consistent behaviour, whether we're run
263
# inside a branch, or not.
264
outer_tree = self.make_branch_and_tree('.')
265
inner_tree = self.make_branch_and_tree('branch')
266
self.build_tree_contents([
267
('branch/foo.c', 'int main() {}'),
268
('branch/bar.c', 'int main() {}')])
269
inner_tree.add('foo.c')
270
inner_tree.add('bar.c')
271
# can't commit files in different trees; sane error
272
self.run_bzr('commit -m newstuff branch/foo.c .', retcode=3)
273
self.run_bzr('commit -m newstuff branch/foo.c')
274
self.run_bzr('commit -m newstuff branch')
275
self.run_bzr('commit -m newstuff branch', retcode=3)
277
def test_out_of_date_tree_commit(self):
278
# check we get an error code and a clear message committing with an out
280
tree = self.make_branch_and_tree('branch')
282
checkout = tree.branch.create_checkout('checkout', lightweight=True)
283
# commit to the original branch to make the checkout out of date
284
tree.commit('message branch', allow_pointless=True)
285
# now commit to the checkout should emit
286
# ERROR: Out of date with the branch, 'bzr update' is suggested
287
output = self.run_bzr('commit --unchanged -m checkout_message '
288
'checkout', retcode=3)
289
self.assertEqual(output,
291
"bzr: ERROR: Working tree is out of date, please "
292
"run 'bzr update'.\n"))
294
def test_local_commit_unbound(self):
295
# a --local commit on an unbound branch is an error
296
self.make_branch_and_tree('.')
297
out, err = self.run_bzr('commit --local', retcode=3)
298
self.assertEqualDiff('', out)
299
self.assertEqualDiff('bzr: ERROR: Cannot perform local-only commits '
300
'on unbound branches.\n', err)
302
def test_commit_a_text_merge_in_a_checkout(self):
303
# checkouts perform multiple actions in a transaction across bond
304
# branches and their master, and have been observed to fail in the
305
# past. This is a user story reported to fail in bug #43959 where
306
# a merge done in a checkout (using the update command) failed to
308
trunk = self.make_branch_and_tree('trunk')
310
u1 = trunk.branch.create_checkout('u1')
311
self.build_tree_contents([('u1/hosts', 'initial contents')])
313
self.run_bzr('commit -m add-hosts u1')
315
u2 = trunk.branch.create_checkout('u2')
316
self.build_tree_contents([('u2/hosts', 'altered in u2')])
317
self.run_bzr('commit -m checkin-from-u2 u2')
319
# make an offline commits
320
self.build_tree_contents([('u1/hosts', 'first offline change in u1')])
321
self.run_bzr('commit -m checkin-offline --local u1')
323
# now try to pull in online work from u2, and then commit our offline
325
# retcode 1 as we expect a text conflict
326
self.run_bzr('update u1', retcode=1)
327
self.run_bzr('resolved u1/hosts')
328
# add a text change here to represent resolving the merge conflicts in
329
# favour of a new version of the file not identical to either the u1
330
# version or the u2 version.
331
self.build_tree_contents([('u1/hosts', 'merge resolution\n')])
332
self.run_bzr('commit -m checkin-merge-of-the-offline-work-from-u1 u1')
334
def test_commit_exclude_excludes_modified_files(self):
335
"""Commit -x foo should ignore changes to foo."""
336
tree = self.make_branch_and_tree('.')
337
self.build_tree(['a', 'b', 'c'])
338
tree.smart_add(['.'])
339
out, err = self.run_bzr(['commit', '-m', 'test', '-x', 'b'])
340
self.assertFalse('added b' in out)
341
self.assertFalse('added b' in err)
342
# If b was excluded it will still be 'added' in status.
343
out, err = self.run_bzr(['added'])
344
self.assertEqual('b\n', out)
345
self.assertEqual('', err)
347
def test_commit_exclude_twice_uses_both_rules(self):
348
"""Commit -x foo -x bar should ignore changes to foo and bar."""
349
tree = self.make_branch_and_tree('.')
350
self.build_tree(['a', 'b', 'c'])
351
tree.smart_add(['.'])
352
out, err = self.run_bzr(['commit', '-m', 'test', '-x', 'b', '-x', 'c'])
353
self.assertFalse('added b' in out)
354
self.assertFalse('added c' in out)
355
self.assertFalse('added b' in err)
356
self.assertFalse('added c' in err)
357
# If b was excluded it will still be 'added' in status.
358
out, err = self.run_bzr(['added'])
359
self.assertTrue('b\n' in out)
360
self.assertTrue('c\n' in out)
361
self.assertEqual('', err)
363
def test_commit_respects_spec_for_removals(self):
364
"""Commit with a file spec should only commit removals that match"""
365
t = self.make_branch_and_tree('.')
366
self.build_tree(['file-a', 'dir-a/', 'dir-a/file-b'])
367
t.add(['file-a', 'dir-a', 'dir-a/file-b'])
369
t.remove(['file-a', 'dir-a/file-b'])
371
result = self.run_bzr('commit . -m removed-file-b')[1]
372
self.assertNotContainsRe(result, 'file-a')
373
result = self.run_bzr('status')[0]
374
self.assertContainsRe(result, 'removed:\n file-a')
376
def test_strict_commit(self):
377
"""Commit with --strict works if everything is known"""
378
ignores._set_user_ignores([])
379
tree = self.make_branch_and_tree('tree')
380
self.build_tree(['tree/a'])
382
# A simple change should just work
383
self.run_bzr('commit --strict -m adding-a',
386
def test_strict_commit_no_changes(self):
387
"""commit --strict gives "no changes" if there is nothing to commit"""
388
tree = self.make_branch_and_tree('tree')
389
self.build_tree(['tree/a'])
391
tree.commit('adding a')
393
# With no changes, it should just be 'no changes'
394
# Make sure that commit is failing because there is nothing to do
395
self.run_bzr_error(['no changes to commit'],
396
'commit --strict -m no-changes',
399
# But --strict doesn't care if you supply --unchanged
400
self.run_bzr('commit --strict --unchanged -m no-changes',
403
def test_strict_commit_unknown(self):
404
"""commit --strict fails if a file is unknown"""
405
tree = self.make_branch_and_tree('tree')
406
self.build_tree(['tree/a'])
408
tree.commit('adding a')
410
# Add one file so there is a change, but forget the other
411
self.build_tree(['tree/b', 'tree/c'])
413
self.run_bzr_error(['Commit refused because there are unknown files'],
414
'commit --strict -m add-b',
417
# --no-strict overrides --strict
418
self.run_bzr('commit --strict -m add-b --no-strict',
421
def test_fixes_bug_output(self):
422
"""commit --fixes=lp:23452 succeeds without output."""
423
tree = self.make_branch_and_tree('tree')
424
self.build_tree(['tree/hello.txt'])
425
tree.add('hello.txt')
426
output, err = self.run_bzr(
427
'commit -m hello --fixes=lp:23452 tree/hello.txt')
428
self.assertEqual('', output)
429
self.assertContainsRe(err, 'Committing to: .*\n'
431
'Committed revision 1\.\n')
433
def test_no_bugs_no_properties(self):
434
"""If no bugs are fixed, the bugs property is not set.
436
see https://beta.launchpad.net/bzr/+bug/109613
438
tree = self.make_branch_and_tree('tree')
439
self.build_tree(['tree/hello.txt'])
440
tree.add('hello.txt')
441
self.run_bzr( 'commit -m hello tree/hello.txt')
442
# Get the revision properties, ignoring the branch-nick property, which
443
# we don't care about for this test.
444
last_rev = tree.branch.repository.get_revision(tree.last_revision())
445
properties = dict(last_rev.properties)
446
del properties['branch-nick']
447
self.assertFalse('bugs' in properties)
449
def test_fixes_bug_sets_property(self):
450
"""commit --fixes=lp:234 sets the lp:234 revprop to 'fixed'."""
451
tree = self.make_branch_and_tree('tree')
452
self.build_tree(['tree/hello.txt'])
453
tree.add('hello.txt')
454
self.run_bzr('commit -m hello --fixes=lp:234 tree/hello.txt')
456
# Get the revision properties, ignoring the branch-nick property, which
457
# we don't care about for this test.
458
last_rev = tree.branch.repository.get_revision(tree.last_revision())
459
properties = dict(last_rev.properties)
460
del properties['branch-nick']
462
self.assertEqual({'bugs': 'https://launchpad.net/bugs/234 fixed'},
465
def test_fixes_multiple_bugs_sets_properties(self):
466
"""--fixes can be used more than once to show that bugs are fixed."""
467
tree = self.make_branch_and_tree('tree')
468
self.build_tree(['tree/hello.txt'])
469
tree.add('hello.txt')
470
self.run_bzr('commit -m hello --fixes=lp:123 --fixes=lp:235'
473
# Get the revision properties, ignoring the branch-nick property, which
474
# we don't care about for this test.
475
last_rev = tree.branch.repository.get_revision(tree.last_revision())
476
properties = dict(last_rev.properties)
477
del properties['branch-nick']
480
{'bugs': 'https://launchpad.net/bugs/123 fixed\n'
481
'https://launchpad.net/bugs/235 fixed'},
484
def test_fixes_bug_with_alternate_trackers(self):
485
"""--fixes can be used on a properly configured branch to mark bug
486
fixes on multiple trackers.
488
tree = self.make_branch_and_tree('tree')
489
tree.branch.get_config().set_user_option(
490
'trac_twisted_url', 'http://twistedmatrix.com/trac')
491
self.build_tree(['tree/hello.txt'])
492
tree.add('hello.txt')
493
self.run_bzr('commit -m hello --fixes=lp:123 --fixes=twisted:235 tree/')
495
# Get the revision properties, ignoring the branch-nick property, which
496
# we don't care about for this test.
497
last_rev = tree.branch.repository.get_revision(tree.last_revision())
498
properties = dict(last_rev.properties)
499
del properties['branch-nick']
502
{'bugs': 'https://launchpad.net/bugs/123 fixed\n'
503
'http://twistedmatrix.com/trac/ticket/235 fixed'},
506
def test_fixes_unknown_bug_prefix(self):
507
tree = self.make_branch_and_tree('tree')
508
self.build_tree(['tree/hello.txt'])
509
tree.add('hello.txt')
511
["Unrecognized bug %s. Commit refused." % 'xxx:123'],
512
'commit -m add-b --fixes=xxx:123',
515
def test_fixes_invalid_bug_number(self):
516
tree = self.make_branch_and_tree('tree')
517
self.build_tree(['tree/hello.txt'])
518
tree.add('hello.txt')
520
["Invalid bug identifier for %s. Commit refused." % 'lp:orange'],
521
'commit -m add-b --fixes=lp:orange',
524
def test_fixes_invalid_argument(self):
525
"""Raise an appropriate error when the fixes argument isn't tag:id."""
526
tree = self.make_branch_and_tree('tree')
527
self.build_tree(['tree/hello.txt'])
528
tree.add('hello.txt')
530
[r"Invalid bug orange. Must be in the form of 'tag:id'\. "
531
r"Commit refused\."],
532
'commit -m add-b --fixes=orange',
535
def test_no_author(self):
536
"""If the author is not specified, the author property is not set."""
537
tree = self.make_branch_and_tree('tree')
538
self.build_tree(['tree/hello.txt'])
539
tree.add('hello.txt')
540
self.run_bzr( 'commit -m hello tree/hello.txt')
541
last_rev = tree.branch.repository.get_revision(tree.last_revision())
542
properties = last_rev.properties
543
self.assertFalse('author' in properties)
545
def test_author_sets_property(self):
546
"""commit --author='John Doe <jdoe@example.com>' sets the author
549
tree = self.make_branch_and_tree('tree')
550
self.build_tree(['tree/hello.txt'])
551
tree.add('hello.txt')
552
self.run_bzr(["commit", '-m', 'hello',
553
'--author', u'John D\xf6 <jdoe@example.com>',
555
last_rev = tree.branch.repository.get_revision(tree.last_revision())
556
properties = last_rev.properties
557
self.assertEqual(u'John D\xf6 <jdoe@example.com>', properties['author'])
559
def test_author_no_email(self):
560
"""Author's name without an email address is allowed, too."""
561
tree = self.make_branch_and_tree('tree')
562
self.build_tree(['tree/hello.txt'])
563
tree.add('hello.txt')
564
out, err = self.run_bzr("commit -m hello --author='John Doe' "
566
last_rev = tree.branch.repository.get_revision(tree.last_revision())
567
properties = last_rev.properties
568
self.assertEqual('John Doe', properties['author'])
570
def test_partial_commit_with_renames_in_tree(self):
571
# this test illustrates bug #140419
572
t = self.make_branch_and_tree('.')
573
self.build_tree(['dir/', 'dir/a', 'test'])
574
t.add(['dir/', 'dir/a', 'test'])
575
t.commit('initial commit')
576
# important part: file dir/a should change parent
577
# and should appear before old parent
578
# then during partial commit we have error
579
# parent_id {dir-XXX} not in inventory
580
t.rename_one('dir/a', 'a')
581
self.build_tree_contents([('test', 'changes in test')])
583
out, err = self.run_bzr('commit test -m "partial commit"')
584
self.assertEquals('', out)
585
self.assertContainsRe(err, r'modified test\nCommitted revision 2.')
587
def test_commit_readonly_checkout(self):
588
# https://bugs.edge.launchpad.net/bzr/+bug/129701
589
# "UnlockableTransport error trying to commit in checkout of readonly
591
self.make_branch('master')
592
master = BzrDir.open_from_transport(
593
self.get_readonly_transport('master')).open_branch()
594
master.create_checkout('checkout')
595
out, err = self.run_bzr(['commit', '--unchanged', '-mfoo', 'checkout'],
597
self.assertContainsRe(err,
598
r'^bzr: ERROR: Cannot lock.*readonly transport')
600
def test_commit_hook_template(self):
601
# Test that commit template hooks work
602
def restoreDefaults():
603
msgeditor.hooks['commit_message_template'] = []
604
osutils.set_or_unset_env('BZR_EDITOR', default_editor)
605
if sys.platform == "win32":
606
f = file('fed.bat', 'w')
607
f.write('@rem dummy fed')
609
default_editor = osutils.set_or_unset_env('BZR_EDITOR', "fed.bat")
611
f = file('fed.sh', 'wb')
612
f.write('#!/bin/sh\n')
614
os.chmod('fed.sh', 0755)
615
default_editor = osutils.set_or_unset_env('BZR_EDITOR', "./fed.sh")
616
self.addCleanup(restoreDefaults)
617
msgeditor.hooks.install_named_hook("commit_message_template",
618
lambda commit_obj, msg: "save me some typing\n", None)
619
tree = self.make_branch_and_tree('tree')
620
self.build_tree(['tree/hello.txt'])
621
tree.add('hello.txt')
622
out, err = self.run_bzr("commit tree/hello.txt")
623
last_rev = tree.branch.repository.get_revision(tree.last_revision())
624
self.assertEqual('save me some typing\n', last_rev.message)
added
removed
bzrlib/tests/blackbox/test_commit.py
